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": "sofia.balestero@example.com",
    "password": "Senha@123"
};

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' => 'sofia.balestero@example.com',
            'password' => 'Senha@123',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/login'
payload = {
    "email": "sofia.balestero@example.com",
    "password": "Senha@123"
}
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. Ex: sofia.balestero@example.com

password   string   

Ex: Senha@123

POST login/sso/{provider}

requer autenticação

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

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

let body = {
    "access_token": "4e0c4ff2481a57e870574bca75304ec5d2c578df131b80ede1701c85c5d2ac98"
};

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/google',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'access_token' => '4e0c4ff2481a57e870574bca75304ec5d2c578df131b80ede1701c85c5d2ac98',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/login/sso/google'
payload = {
    "access_token": "4e0c4ff2481a57e870574bca75304ec5d2c578df131b80ede1701c85c5d2ac98"
}
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   string   

Ex: google

Parâmetros do body

access_token   string   

Ex: 4e0c4ff2481a57e870574bca75304ec5d2c578df131b80ede1701c85c5d2ac98

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": "25f4f4acacfdbfb692e09b8bd58ce542f003e2a4fdb5a0ab3ccac993e1868f25"
};

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' => '25f4f4acacfdbfb692e09b8bd58ce542f003e2a4fdb5a0ab3ccac993e1868f25',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/login/validate-captcha'
payload = {
    "token": "25f4f4acacfdbfb692e09b8bd58ce542f003e2a4fdb5a0ab3ccac993e1868f25"
}
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   

Ex: 25f4f4acacfdbfb692e09b8bd58ce542f003e2a4fdb5a0ab3ccac993e1868f25

POST users/resend-verification-email

requer autenticação

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

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

let body = {
    "email": "tessalia33@example.org"
};

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/resend-verification-email',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'email' => 'tessalia33@example.org',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/users/resend-verification-email'
payload = {
    "email": "tessalia33@example.org"
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Request   

POST users/resend-verification-email

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros do body

email   string   

Deve ser um endereço de e-mail válido. Deve corresponder a um valor já cadastrado. Ex: tessalia33@example.org

Autenticação em duas etapas

Habilitar a autenticação em duas etapas

requer autenticação

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

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/two-factor/enable',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/two-factor/enable'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

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

Request   

POST two-factor/enable

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Desabilitar a autenticação em duas etapas

requer autenticação

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

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/two-factor/disable',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/two-factor/disable'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

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

Request   

PUT two-factor/disable

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Confirmar a ativação da autenticação em duas etapas

requer autenticação

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

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

let body = {
    "code": "meu-codigo"
};

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/two-factor/confirm',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'code' => 'meu-codigo',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/two-factor/confirm'
payload = {
    "code": "meu-codigo"
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Request   

POST two-factor/confirm

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros do body

code   string   

Ex: meu-codigo

Concluir o login enviando o código de duas etapas

requer autenticação

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

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

let body = {
    "challenge_token": "8d1cbffd159ca143d7e61c41dd48c34a2d3b82e0882b1d59f851640d3ad5788a",
    "code": "meu-codigo",
    "recovery_code": "763405"
};

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/two-factor/login',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'challenge_token' => '8d1cbffd159ca143d7e61c41dd48c34a2d3b82e0882b1d59f851640d3ad5788a',
            'code' => 'meu-codigo',
            'recovery_code' => '763405',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/two-factor/login'
payload = {
    "challenge_token": "8d1cbffd159ca143d7e61c41dd48c34a2d3b82e0882b1d59f851640d3ad5788a",
    "code": "meu-codigo",
    "recovery_code": "763405"
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Request   

POST two-factor/login

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros do body

challenge_token   string   

Deve ter pelo menos 10 caracteres. Ex: 8d1cbffd159ca143d7e61c41dd48c34a2d3b82e0882b1d59f851640d3ad5788a

code   string  opcional  

Este campo é obrigatório quando recovery_code for not present. Ex: meu-codigo

recovery_code   string  opcional  

Este campo é obrigatório quando code for not present. Ex: 763405

Campos personalizados

Listar todos os campos personalizados

requer autenticação

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

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/custom-fields',
    [
        '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/custom-fields'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

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

Request   

GET customers/custom-fields

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, user, user_count, userExists, customer, customer_count, customerExists

filter   array  opcional  

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

Criar um campo personalizado

requer autenticação

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

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

let body = {
    "code": "meu-codigo",
    "label": "Meu label",
    "type": "string",
    "required": true,
    "select_options": [
        {
            "value": "exemplo",
            "label": "Meu label"
        }
    ],
    "service_id": 908,
    "order": 0
};

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/customers/custom-fields',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'code' => 'meu-codigo',
            'label' => 'Meu label',
            'type' => 'string',
            'required' => true,
            'select_options' => [
                ['value' => 'exemplo', 'label' => 'Meu label'],
            ],
            'service_id' => 908,
            'order' => 0,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/customers/custom-fields'
payload = {
    "code": "meu-codigo",
    "label": "Meu label",
    "type": "string",
    "required": true,
    "select_options": [
        {
            "value": "exemplo",
            "label": "Meu label"
        }
    ],
    "service_id": 908,
    "order": 0
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Exemplo de resposta (200):


{
    "id": 1,
    "customer_id": 97,
    "user_id": 495,
    "service_id": 801,
    "code": "meu-codigo",
    "label": "Meu label",
    "type": "exemplo",
    "required": true,
    "select_options": [],
    "created_at": "2026-10-02T20:24:11.968407Z",
    "updated_at": "2026-10-02T20:24:11.968522Z",
    "order": 1
}

Request   

POST customers/custom-fields

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros do body

code   string   

Não pode ser superior a 255 caracteres. Ex: meu-codigo

label   string   

Não pode ser superior a 255 caracteres. Ex: Meu label

type   string   

Ex: string

Deve ser um destes:
  • string
  • integer
  • decimal
  • select
  • boolean
required   boolean   

Ex: true

select_options   object[]  opcional  

Este campo é obrigatório quando type for select. Deve ter pelo menos 1 item.
value   string  opcional  

Este campo é obrigatório quando type for select. Não pode ser superior a 255 caracteres. Ex: exemplo

label   string  opcional  

Este campo é obrigatório quando type for select. Não pode ser superior a 255 caracteres. Ex: Meu label

service_id   integer  opcional  

Deve corresponder a um valor já cadastrado. Ex: 908

order   integer   

Deve ser pelo menos 0. Ex: 0

Editar um campo personalizado

requer autenticação

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

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

let body = {
    "code": "meu-codigo",
    "label": "Meu label",
    "type": "string",
    "required": true,
    "select_options": [
        {
            "value": "exemplo",
            "label": "Meu label"
        }
    ],
    "service_id": 63,
    "order": 0
};

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/customers/custom-fields/10',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'code' => 'meu-codigo',
            'label' => 'Meu label',
            'type' => 'string',
            'required' => true,
            'select_options' => [
                ['value' => 'exemplo', 'label' => 'Meu label'],
            ],
            'service_id' => 63,
            'order' => 0,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/customers/custom-fields/10'
payload = {
    "code": "meu-codigo",
    "label": "Meu label",
    "type": "string",
    "required": true,
    "select_options": [
        {
            "value": "exemplo",
            "label": "Meu label"
        }
    ],
    "service_id": 63,
    "order": 0
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Exemplo de resposta (200):


{
    "id": 1,
    "customer_id": 452,
    "user_id": 465,
    "service_id": 904,
    "code": "meu-codigo",
    "label": "Meu label",
    "type": "exemplo",
    "required": true,
    "select_options": [],
    "created_at": "2026-10-02T20:24:11.993355Z",
    "updated_at": "2026-10-02T20:24:11.993491Z",
    "order": 1
}

Request   

PUT customers/custom-fields/{customerCustomOrderField_id}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros da URL

customerCustomOrderField_id   integer   

O ID do customerCustomOrderField. Ex: 10

Parâmetros do body

code   string   

Não pode ser superior a 255 caracteres. Ex: meu-codigo

label   string   

Não pode ser superior a 255 caracteres. Ex: Meu label

type   string   

Ex: string

Deve ser um destes:
  • string
  • integer
  • decimal
  • select
  • boolean
required   boolean   

Ex: true

select_options   object[]  opcional  

Este campo é obrigatório quando type for select. Deve ter pelo menos 1 item.
value   string  opcional  

Este campo é obrigatório quando type for select. Não pode ser superior a 255 caracteres. Ex: exemplo

label   string  opcional  

Este campo é obrigatório quando type for select. Não pode ser superior a 255 caracteres. Ex: Meu label

service_id   integer  opcional  

Deve corresponder a um valor já cadastrado. Ex: 63

order   integer   

Deve ser pelo menos 0. Ex: 0

Excluir um ou múltiplos campos personalizados

requer autenticação

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

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/customers/custom-fields/magni',
    [
        '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/custom-fields/magni'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

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

Request   

DELETE customers/custom-fields/{customFields}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

customFields   string   

Ex: magni

Carteira (Pré pago)

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

requer autenticação Disponível apenas para clientes pré pagos

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 = {
    "payment_method": "credit-card",
    "amount": 1.5,
    "credit_card_document_number": "12531053913",
    "credit_card_holder_name": "Dr. Mary Ramos Rico",
    "credit_card_number": "5041750789870110",
    "credit_card_cvv": 981,
    "credit_card_due_date": "05\/27",
    "send_email_after_approved": true
};

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' => [
            'payment_method' => 'credit-card',
            'amount' => 1.5,
            'credit_card_document_number' => '12531053913',
            'credit_card_holder_name' => 'Dr. Mary Ramos Rico',
            'credit_card_number' => '5041750789870110',
            'credit_card_cvv' => 981,
            'credit_card_due_date' => '05/27',
            'send_email_after_approved' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/wallets/deposits'
payload = {
    "payment_method": "credit-card",
    "amount": 1.5,
    "credit_card_document_number": "12531053913",
    "credit_card_holder_name": "Dr. Mary Ramos Rico",
    "credit_card_number": "5041750789870110",
    "credit_card_cvv": 981,
    "credit_card_due_date": "05\/27",
    "send_email_after_approved": true
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Exemplo de resposta (200):


{
    "id": 1,
    "customer_id": 66,
    "user_id": 83,
    "order_id": 912,
    "operation": "C",
    "approved_at": "2026-10-02T20:24:13.790038Z",
    "amount": 1.5,
    "payment_method": "credit-card",
    "backoffice_id": 6346946,
    "bank_slip_url": "http://santiago.br/voluptatem-nulla-facilis-ad-veniam-vel-ut-placeat.html",
    "bank_slip_barcode": "exemplo",
    "bonus_amount": 1.5,
    "send_email_after_approved": true,
    "purchase_id": 341,
    "type": "refund",
    "backoffice_reason": "Labore sit minus ut saepe.",
    "pix_qr_code": "dj-5724",
    "pix_hash": "exemplo",
    "created_at": "2026-10-02T20:24:13.790944Z",
    "updated_at": "2026-10-02T20:24:13.791104Z"
}

Request   

POST wallets/deposits

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros do body

payment_method   string   

Ex: credit-card

Deve ser um destes:
  • credit-card
  • bank-slip
  • pix
amount   number   

Ex: 1.5

credit_card_document_number   string  opcional  

Este campo é obrigatório quando payment_method for credit-card. Ex: 12531053913

credit_card_holder_name   string  opcional  

Este campo é obrigatório quando payment_method for credit-card. Ex: Dr. Mary Ramos Rico

credit_card_number   string  opcional  

@var array $invoiceRules Este campo é obrigatório quando payment_method for credit-card. Ex: 5041750789870110

credit_card_cvv   string  opcional  

Este campo é obrigatório quando payment_method for credit-card. Não pode ser superior a 4 caracteres. Ex: 981

credit_card_due_date   string  opcional  

Este campo é obrigatório quando payment_method for credit-card. Deve ser uma data válida no formato Y-m. Deve ser uma data posterior ou igual a 2026-10. Ex: 05/27

send_email_after_approved   boolean   

Ex: true

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

requer autenticação Disponível apenas para clientes pré pagos

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

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()

Exemplo de resposta (200):


{
    "id": 1,
    "name": "Violeta Valência",
    "corporate_name": "Galvão-Pontes",
    "entity_type": "PF",
    "phone": "8946592881",
    "document_number": "17965485532",
    "address_zip_code": "76292091",
    "address_public_place": "Av. Rayane",
    "address_number": "973",
    "address_complement": "Apto 12",
    "address_neighborhood": "Centro",
    "address_city": "Willian do Sul",
    "address_uf": "PB",
    "backoffice_email": "santiago00@example.org",
    "sync_with_backoffice": true,
    "postpaid": true,
    "explorer_item_file_upload_enabled": true,
    "ai_enrich_data_enabled": true,
    "group_mandatory_on_purchase": true,
    "demands_approval_purchases_over_value": 1.5,
    "created_from_passport": true,
    "generate_services_summary": true,
    "show_shipping_info_on_orders": 1,
    "credit_bonus_disabled": 1,
    "control_downloaded_orders_by": "user",
    "plan": "exemplo",
    "plan_max_users": 1,
    "plan_analytics_enabled_until": "2026-10-02",
    "plan_free_emoluments_orders_included": 1,
    "plan_free_dossiers_orders_included": 1,
    "plan_ai_extractions_included": 1,
    "plan_ai_tokens_included": 1,
    "plan_paid_until": "2026-10-02",
    "plan_changed_at": "2026-10-02",
    "created_at": "2026-10-02T20:24:11.902072Z",
    "updated_at": "2026-10-02T20:24:11.902166Z",
    "api_access_enabled": true
}

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, account_balance_total_bonuses, used_storage, prepaid, total_ai_tokens_remaining, ai_tokens_above_limit, plan_free_emoluments_orders_remaining, plan_ai_extractions_remaining

Visualizar as estatísticas de uso do plano do cliente logado no mês atual

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/customers/plan/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/customers/plan/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/customers/plan/stats'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

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

Request   

GET customers/plan/stats

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, account_balance_total_bonuses, used_storage, prepaid, total_ai_tokens_remaining, ai_tokens_above_limit, plan_free_emoluments_orders_remaining, plan_ai_extractions_remaining

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}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "phone": "18929792076",
    "address_zip_code": "77085024",
    "address_public_place": "Av. Luna Verdara",
    "address_number": "28086",
    "address_complement": "Apto 12",
    "address_neighborhood": "Centro",
    "address_city": "Vitor d'Oeste",
    "address_uf": "RR",
    "group_mandatory_on_purchase": true
};

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/customers',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'phone' => '18929792076',
            'address_zip_code' => '77085024',
            'address_public_place' => 'Av. Luna Verdara',
            'address_number' => '28086',
            'address_complement' => 'Apto 12',
            'address_neighborhood' => 'Centro',
            'address_city' => 'Vitor d\'Oeste',
            'address_uf' => 'RR',
            'group_mandatory_on_purchase' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/customers'
payload = {
    "phone": "18929792076",
    "address_zip_code": "77085024",
    "address_public_place": "Av. Luna Verdara",
    "address_number": "28086",
    "address_complement": "Apto 12",
    "address_neighborhood": "Centro",
    "address_city": "Vitor d'Oeste",
    "address_uf": "RR",
    "group_mandatory_on_purchase": true
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Exemplo de resposta (200):


{
    "id": 1,
    "name": "Dr. Emanuel Duarte Mendonça",
    "corporate_name": "Marés e Associados",
    "entity_type": "PF",
    "phone": "3327298815",
    "document_number": "94163045902",
    "address_zip_code": "63066609",
    "address_public_place": "Avenida Anita",
    "address_number": "71711",
    "address_complement": "Apto 12",
    "address_neighborhood": "Centro",
    "address_city": "São Manuel",
    "address_uf": "RS",
    "backoffice_email": "ian.aragao@example.com",
    "sync_with_backoffice": true,
    "postpaid": true,
    "explorer_item_file_upload_enabled": true,
    "ai_enrich_data_enabled": true,
    "group_mandatory_on_purchase": true,
    "demands_approval_purchases_over_value": 1.5,
    "created_from_passport": true,
    "generate_services_summary": true,
    "show_shipping_info_on_orders": 1,
    "credit_bonus_disabled": 1,
    "control_downloaded_orders_by": "user",
    "plan": "exemplo",
    "plan_max_users": 1,
    "plan_analytics_enabled_until": "2026-10-02",
    "plan_free_emoluments_orders_included": 1,
    "plan_free_dossiers_orders_included": 1,
    "plan_ai_extractions_included": 1,
    "plan_ai_tokens_included": 1,
    "plan_paid_until": "2026-10-02",
    "plan_changed_at": "2026-10-02",
    "created_at": "2026-10-02T20:24:11.941169Z",
    "updated_at": "2026-10-02T20:24:11.941306Z",
    "api_access_enabled": true
}

Request   

PATCH customers

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros do body

phone   string  opcional  

Não pode ser superior a 20 caracteres. Ex: 18929792076

address_zip_code   string  opcional  

Não pode ser superior a 8 caracteres. Ex: 77085024

address_public_place   string  opcional  

Não pode ser superior a 120 caracteres. Ex: Av. Luna Verdara

address_number   string  opcional  

Não pode ser superior a 8 caracteres. Ex: 28086

address_complement   string  opcional  

Não pode ser superior a 60 caracteres. Ex: Apto 12

address_neighborhood   string  opcional  

Não pode ser superior a 80 caracteres. Ex: Centro

address_city   string  opcional  

Não pode ser superior a 120 caracteres. Ex: Vitor d'Oeste

address_uf   string  opcional  

Não pode ser superior a 2 caracteres. Ex: RR

group_mandatory_on_purchase   boolean  opcional  

Ex: true

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": "Robson Vicente Teles",
    "shipping_address_zip_code": "87130239",
    "shipping_address_number": "18631",
    "shipping_address_neighborhood": "Centro",
    "shipping_address_public_place": "Av. Cervantes",
    "shipping_address_city": "Marés do Norte",
    "shipping_address_uf": "RR",
    "shipping_address_complement": "Apto 12",
    "post_payment": true,
    "post_payment_method": "credit-card",
    "groups_ids": [
        545,
        759
    ],
    "orders": [
        {
            "name": "Milena Marques Neto",
            "service_id": 250,
            "service_code": "nf-9756",
            "auto_purchase_certificate_from_result_negative": true,
            "auto_purchase_certificate_from_result_positive": true,
            "detailed_service_data": [],
            "custom_fields": []
        }
    ],
    "shopping_cart_id": "caf25e368b64bafaf18eca52cea4f67e9f72a828dfc474e8d4b386aabcf945ef"
};

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' => 'Robson Vicente Teles',
            'shipping_address_zip_code' => '87130239',
            'shipping_address_number' => '18631',
            'shipping_address_neighborhood' => 'Centro',
            'shipping_address_public_place' => 'Av. Cervantes',
            'shipping_address_city' => 'Marés do Norte',
            'shipping_address_uf' => 'RR',
            'shipping_address_complement' => 'Apto 12',
            'post_payment' => true,
            'post_payment_method' => 'credit-card',
            'groups_ids' => [545, 759],
            'orders' => [
                [
                    'name' => 'Milena Marques Neto',
                    'service_id' => 250,
                    'service_code' => 'nf-9756',
                    'auto_purchase_certificate_from_result_negative' => true,
                    'auto_purchase_certificate_from_result_positive' => true,
                    'detailed_service_data' => [],
                    'custom_fields' => [],
                ],
            ],
            'shopping_cart_id' => 'caf25e368b64bafaf18eca52cea4f67e9f72a828dfc474e8d4b386aabcf945ef',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/purchases'
payload = {
    "name": "Robson Vicente Teles",
    "shipping_address_zip_code": "87130239",
    "shipping_address_number": "18631",
    "shipping_address_neighborhood": "Centro",
    "shipping_address_public_place": "Av. Cervantes",
    "shipping_address_city": "Marés do Norte",
    "shipping_address_uf": "RR",
    "shipping_address_complement": "Apto 12",
    "post_payment": true,
    "post_payment_method": "credit-card",
    "groups_ids": [
        545,
        759
    ],
    "orders": [
        {
            "name": "Milena Marques Neto",
            "service_id": 250,
            "service_code": "nf-9756",
            "auto_purchase_certificate_from_result_negative": true,
            "auto_purchase_certificate_from_result_positive": true,
            "detailed_service_data": [],
            "custom_fields": []
        }
    ],
    "shopping_cart_id": "caf25e368b64bafaf18eca52cea4f67e9f72a828dfc474e8d4b386aabcf945ef"
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Exemplo de resposta (200):


{
    "id": 1,
    "backoffice_code": "1420268907949",
    "user_id": 563,
    "customer_id": 513,
    "placed_at": "2026-10-02T20:24:12.818282Z",
    "name": "Ana Leon Santiago Jr.",
    "total_cost": 194.71,
    "total_estimated_cost_postpaid_customer": 1.5,
    "type": "Mixed",
    "shipping_address_zip_code": "16613719",
    "shipping_address_neighborhood": "Centro",
    "shipping_address_public_place": "Largo Emilly Duarte",
    "shipping_address_number": "35528",
    "shipping_address_city": "Pena d'Oeste",
    "shipping_address_uf": "RO",
    "shipping_address_complement": "Apto 12",
    "shipping_address_is_international": true,
    "shipping_address_country": "exemplo",
    "imported_at": "2026-10-02T20:24:12.819573Z",
    "recurrence_id": 39,
    "automatic_generated_from_id": 683,
    "created_at": "2026-10-02T20:24:12.819676Z",
    "updated_at": "2026-10-02T20:24:12.819717Z",
    "quoted_cost_postpaid_customer": "484.93",
    "quoted_rejected_reason": "Ut eos quidem fugiat qui rerum.",
    "quote_appraiser_id": 884,
    "status": "creating",
    "backoffice_hash": "exemplo",
    "created_using_spreadsheet": 1,
    "finished_at": "2026-10-02T20:24:12.819963Z"
}

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. Ex: Robson Vicente Teles

shipping_address_zip_code   string  opcional  

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

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 Ex: 18631

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 Ex: Centro

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 Ex: Av. Cervantes

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 Ex: Marés do Norte

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 Ex: RR

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 Ex: Apto 12

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. Ex: true

post_payment_method   string  opcional  

Obrigatório quando post_payment é igual a true. Ex: credit-card

. 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. Ex: Milena Marques Neto

service_id   integer  opcional  

O ID do serviço. Consulte em link Ex: 250

service_code   string  opcional  

Obrigatório quando orders.*.service_id não está presente. Must match an existing stored value. O código do serviço. Consulte em link Ex: nf-9756

auto_purchase_certificate_from_result_negative   boolean  opcional  

Ex: true

auto_purchase_certificate_from_result_positive   boolean  opcional  

Ex: true

detailed_service_data   object   

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

custom_fields   object  opcional  

Os Campos personalizados da sua conta vão aqui. 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. Ex: caf25e368b64bafaf18eca52cea4f67e9f72a828dfc474e8d4b386aabcf945ef

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": [
        774,
        508
    ],
    "orders": [
        {
            "name": "Regiane Andréia Ortega Filho",
            "service_id": 842,
            "service_code": "pv-4443",
            "auto_purchase_certificate_from_result_negative": true,
            "auto_purchase_certificate_from_result_positive": true,
            "detailed_service_data": [],
            "custom_fields": []
        }
    ],
    "shopping_cart_id": "bdb6fc9f12fb9ed44d6ce25d6847d6d1dba27a08070bde302d712f2293edd1be"
};

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' => [774, 508],
            'orders' => [
                [
                    'name' => 'Regiane Andréia Ortega Filho',
                    'service_id' => 842,
                    'service_code' => 'pv-4443',
                    'auto_purchase_certificate_from_result_negative' => true,
                    'auto_purchase_certificate_from_result_positive' => true,
                    'detailed_service_data' => [],
                    'custom_fields' => [],
                ],
            ],
            'shopping_cart_id' => 'bdb6fc9f12fb9ed44d6ce25d6847d6d1dba27a08070bde302d712f2293edd1be',
        ],
    ]
);
$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": [
        774,
        508
    ],
    "orders": [
        {
            "name": "Regiane Andréia Ortega Filho",
            "service_id": 842,
            "service_code": "pv-4443",
            "auto_purchase_certificate_from_result_negative": true,
            "auto_purchase_certificate_from_result_positive": true,
            "detailed_service_data": [],
            "custom_fields": []
        }
    ],
    "shopping_cart_id": "bdb6fc9f12fb9ed44d6ce25d6847d6d1dba27a08070bde302d712f2293edd1be"
}
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. Ex: Regiane Andréia Ortega Filho

service_id   integer  opcional  

O ID do serviço. Consulte em link Ex: 842

service_code   string  opcional  

Obrigatório quando orders.*.service_id não está presente. Must match an existing stored value. O código do serviço. Consulte em link Ex: pv-4443

auto_purchase_certificate_from_result_negative   boolean  opcional  

Ex: true

auto_purchase_certificate_from_result_positive   boolean  opcional  

Ex: true

detailed_service_data   object   

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

custom_fields   object  opcional  

Os Campos personalizados da sua conta vão aqui. 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. Ex: bdb6fc9f12fb9ed44d6ce25d6847d6d1dba27a08070bde302d712f2293edd1be

Visualizar uma compra

requer autenticação

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

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/0-9',
    [
        '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/0-9'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

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

Exemplo de resposta (200):


{
    "id": 1,
    "backoffice_code": "1420268168168",
    "user_id": 835,
    "customer_id": 44,
    "placed_at": "2026-10-02T20:24:12.876729Z",
    "name": "Matheus Paz Jr.",
    "total_cost": 97.09,
    "total_estimated_cost_postpaid_customer": 1.5,
    "type": "Mixed",
    "shipping_address_zip_code": "71316327",
    "shipping_address_neighborhood": "Centro",
    "shipping_address_public_place": "Rua Joaquim",
    "shipping_address_number": "9531",
    "shipping_address_city": "Porto Sheila do Leste",
    "shipping_address_uf": "MS",
    "shipping_address_complement": "Apto 12",
    "shipping_address_is_international": true,
    "shipping_address_country": "exemplo",
    "imported_at": "2026-10-02T20:24:12.878335Z",
    "recurrence_id": 879,
    "automatic_generated_from_id": 635,
    "created_at": "2026-10-02T20:24:12.878519Z",
    "updated_at": "2026-10-02T20:24:12.878605Z",
    "quoted_cost_postpaid_customer": "228.66",
    "quoted_rejected_reason": "Est reprehenderit delectus vero quos.",
    "quote_appraiser_id": 383,
    "status": "creating",
    "backoffice_hash": "exemplo",
    "created_using_spreadsheet": 1,
    "finished_at": "2026-10-02T20:24:12.878978Z"
}

Request   

GET purchases/{id}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

id   integer   

O ID da compra. Ex: 0-9

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

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": "Samuel Jerônimo Roque"
};

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' => 'Samuel Jerônimo Roque',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/purchases/10/name'
payload = {
    "name": "Samuel Jerônimo Roque"
}
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. Ex: Samuel Jerônimo Roque

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

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, finished_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_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}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "quoted_rejected_reason": "Non iusto ducimus nisi accusantium quia fuga."
};

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/purchases/10/quote/',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'quoted_rejected_reason' => 'Non iusto ducimus nisi accusantium quia fuga.',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/purchases/10/quote/'
payload = {
    "quoted_rejected_reason": "Non iusto ducimus nisi accusantium quia fuga."
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Request   

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

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

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  

Este campo é obrigatório quando quote_status for reject. Não pode ser superior a 120 caracteres. Ex: Non iusto ducimus nisi accusantium quia fuga.

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 headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "group_by": "purchase"
};

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/purchases/123,456,789/download',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'group_by' => 'purchase',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/purchases/123,456,789/download'
payload = {
    "group_by": "purchase"
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Request   

GET purchases/{purchases}/download

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros da URL

purchases   string   

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

Parâmetros do body

group_by   string  opcional  

Ex: purchase

Deve ser um destes:
  • purchase
  • 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": "1",
};
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' => '1',
        ],
    ]
);
$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': '1',
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

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

Exemplo de resposta (200):


{
    "file_path": "exemplo",
    "download_name": "exemplo"
}

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  

O formato do relatório. Se omitido, o padrão é xlsx.

Parâmetros da query

oneResultPerRow   boolean  opcional  

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

Calcula o preço e prazo de entrega da compra

requer autenticação

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

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

let body = {
    "orders": [
        {
            "service_id": 533,
            "detailed_service_data": []
        }
    ]
};

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/purchases/prices-shipping-info',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'orders' => [
                [
                    'service_id' => 533,
                    'detailed_service_data' => [],
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/purchases/prices-shipping-info'
payload = {
    "orders": [
        {
            "service_id": 533,
            "detailed_service_data": []
        }
    ]
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Exemplo de resposta (200):


{
    "purchase": [],
    "items": []
}

Request   

PUT purchases/prices-shipping-info

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros do body

orders   object[]   

Deve ter pelo menos 1 item.
service_id   integer   

Must match an existing stored value. Ex: 533

detailed_service_data   string   

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}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "services": []
};

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',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'services' => [],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/automations/automatic-purchases'
payload = {
    "services": []
}
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

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

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": 33,
            "ai_model_id": 673
        }
    ]
};

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' => 33, 'ai_model_id' => 673],
            ],
        ],
    ]
);
$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": 33,
            "ai_model_id": 673
        }
    ]
}
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   

Deve corresponder a um valor já cadastrado. Ex: 33

ai_model_id   integer   

Ex: 673

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": [
        1
    ]
};

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' => [1],
        ],
    ]
);
$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": [
        1
    ]
}
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[]   

Deve corresponder a um valor já cadastrado.

Definir compra automática de certidões a partir de dados extraídos com IA

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": [
        1
    ]
};

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' => [1],
        ],
    ]
);
$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": [
        1
    ]
}
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[]   

Deve corresponder a um valor já cadastrado.

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": 939,
    "expiration_days": 1
};

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' => 939,
            'expiration_days' => 1,
        ],
    ]
);
$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": 939,
    "expiration_days": 1
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Exemplo de resposta (200):


{
    "id": 1,
    "user_id": 150,
    "customer_id": 367,
    "service_id": 669,
    "expiration_days": 1,
    "created_at": "2026-10-02T20:24:11.806014Z",
    "updated_at": "2026-10-02T20:24:11.806216Z"
}

Request   

POST customer-service-expirations

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros do body

service_id   integer   

Deve corresponder a um valor já cadastrado. Ex: 939

expiration_days   integer   

Deve ser pelo menos 1. Ex: 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": 579,
    "expiration_days": 1
};

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' => 579,
            'expiration_days' => 1,
        ],
    ]
);
$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": 579,
    "expiration_days": 1
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Exemplo de resposta (200):


{
    "id": 1,
    "user_id": 749,
    "customer_id": 530,
    "service_id": 354,
    "expiration_days": 1,
    "created_at": "2026-10-02T20:24:11.824982Z",
    "updated_at": "2026-10-02T20:24:11.825284Z"
}

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   

Deve corresponder a um valor já cadastrado. Ex: 579

expiration_days   integer   

Deve ser pelo menos 1. Ex: 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

Listar as janelas de similaridade de documento

requer autenticação

O retorno é paginado

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

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-similarity-window',
    [
        '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-similarity-window'
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-similarity-window

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

Quando um novo pedido está sendo criado pela interface o sistema consulta se existe um pedido similar já existente, se existir, confirma com o usuário se ele quer prosseguir com a compra. Essa consulta busca em toda a história de pedidos da conta.

requer autenticação

Esse endpoint permite limitar a busca a um período de dias, últimos 60 dias, por exemplo, por serviço. Você pode configurar que para certidão de nascimento busque as similares apenas nos últimos 30 dias, ao invés do período completo.

O endpoint de consulta de similares está disponível para consulta aqui no link

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

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

let body = {
    "service_id": 86,
    "window_days": 1
};

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-similarity-window',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'service_id' => 86,
            'window_days' => 1,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/customer-service-similarity-window'
payload = {
    "service_id": 86,
    "window_days": 1
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Exemplo de resposta (200):


{
    "id": 1,
    "user_id": 654,
    "customer_id": 796,
    "service_id": 260,
    "window_days": 1,
    "created_at": "2026-10-02T20:24:11.853710Z",
    "updated_at": "2026-10-02T20:24:11.853901Z"
}

Request   

POST customer-service-similarity-window

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros do body

service_id   integer   

Deve corresponder a um valor já cadastrado. Ex: 86

window_days   integer   

Deve ser pelo menos 1. Ex: 1

Alterar um modelo de janela de similaridade de documento

requer autenticação

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

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

let body = {
    "window_days": 1
};

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-similarity-window/10',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'window_days' => 1,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/customer-service-similarity-window/10'
payload = {
    "window_days": 1
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Exemplo de resposta (200):


{
    "id": 1,
    "user_id": 277,
    "customer_id": 894,
    "service_id": 819,
    "window_days": 1,
    "created_at": "2026-10-02T20:24:11.877010Z",
    "updated_at": "2026-10-02T20:24:11.877203Z"
}

Request   

PUT customer-service-similarity-window/{customerServiceSimilarityWindow_id}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros da URL

customerServiceSimilarityWindow_id   integer   

O ID do customerServiceSimilarityWindow. Ex: 10

Parâmetros do body

window_days   integer   

Deve ser pelo menos 1. Ex: 1

Excluir um modelo de janela de similaridade de documento

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/customer-service-similarity-window/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-similarity-window/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-similarity-window/10'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

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

Request   

DELETE customer-service-similarity-window/{customerServiceSimilarityWindow_id}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

customerServiceSimilarityWindow_id   integer   

O ID do customerServiceSimilarityWindow. 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": "Sapiente suscipit illo.",
    "body": "Magni non aut corporis culpa inventore maxime debitis."
};

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' => 'Sapiente suscipit illo.',
            'body' => 'Magni non aut corporis culpa inventore maxime debitis.',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/contacts/help'
payload = {
    "subject": "Sapiente suscipit illo.",
    "body": "Magni non aut corporis culpa inventore maxime debitis."
}
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. Ex: Sapiente suscipit illo.

body   string   

Não pode ser superior a 10000 caracteres. Ex: Magni non aut corporis culpa inventore maxime debitis.

Dossiês

Listar dossiês

requer autenticação

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

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/dossiers',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

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

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

Request   

GET dossiers

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

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: name_or_person_document, status, expired

Listar pessoas/empresas para as quais nunca foi feito um dossiê

requer autenticação

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

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/dossiers/never-ordered',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/dossiers/never-ordered'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

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

Request   

GET dossiers/never-ordered

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

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: person_document

Faturas (Pré pago)

Visualizar uma fatura pelo ID

requer autenticação Disponível apenas para clientes pré pagos

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

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/0-9',
    [
        '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/0-9'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

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

Exemplo de resposta (200):


{
    "id": 1,
    "customer_id": 674,
    "user_id": 825,
    "order_id": 211,
    "operation": "C",
    "approved_at": "2026-10-02T20:24:12.374682Z",
    "amount": 1.5,
    "payment_method": "credit-card",
    "backoffice_id": 1554314,
    "bank_slip_url": "http://www.molina.com/id-nihil-reiciendis-ipsa-similique-cupiditate.html",
    "bank_slip_barcode": "exemplo",
    "bonus_amount": 1.5,
    "send_email_after_approved": true,
    "purchase_id": 698,
    "type": "refund",
    "backoffice_reason": "Voluptas sequi provident ut quia et eveniet illum.",
    "pix_qr_code": "qq-5580",
    "pix_hash": "exemplo",
    "created_at": "2026-10-02T20:24:12.376065Z",
    "updated_at": "2026-10-02T20:24:12.376174Z"
}

Request   

GET invoices/{id}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

id   string   

O ID do invoice. Ex: 0-9

Listar as faturas da conta

requer autenticação Disponível apenas para clientes pré pagos

O retorno é paginado por padrão

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/invoices/by-period/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/by-period/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/by-period/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/by-period/{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 Disponível apenas para clientes pré pagos

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/invoices/by-period/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/by-period/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/by-period/2023/1/stats'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

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

Request   

GET invoices/by-period/{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 Disponível apenas para clientes pós pagos (Com contrato)

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 Disponível apenas para clientes pós pagos (Com contrato)

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

Gestor

Altera o email da conta (backoffice_email), sincronizando o email do primeiro usuário da conta e avisando o Backoffice externo.

requer autenticação

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

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

let body = {
    "account_email": "dacruz.theo@example.org"
};

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/gestor/customers/10/backoffice-email',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'account_email' => 'dacruz.theo@example.org',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/gestor/customers/10/backoffice-email'
payload = {
    "account_email": "dacruz.theo@example.org"
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Exemplo de resposta (200):


{
    "id": 1,
    "name": "Paulo Benites Aguiar",
    "corporate_name": "Faro e Dominato Ltda.",
    "entity_type": "PF",
    "phone": "21938854846",
    "document_number": "04737011541",
    "address_zip_code": "13376627",
    "address_public_place": "Rua Suelen",
    "address_number": "1",
    "address_complement": "Apto 12",
    "address_neighborhood": "Centro",
    "address_city": "Vila James do Norte",
    "address_uf": "ES",
    "backoffice_email": "lmolina@example.org",
    "sync_with_backoffice": true,
    "postpaid": true,
    "explorer_item_file_upload_enabled": true,
    "ai_enrich_data_enabled": true,
    "group_mandatory_on_purchase": true,
    "demands_approval_purchases_over_value": 1.5,
    "created_from_passport": true,
    "generate_services_summary": true,
    "show_shipping_info_on_orders": 1,
    "credit_bonus_disabled": 1,
    "control_downloaded_orders_by": "user",
    "plan": "exemplo",
    "plan_max_users": 1,
    "plan_analytics_enabled_until": "2026-10-02",
    "plan_free_emoluments_orders_included": 1,
    "plan_free_dossiers_orders_included": 1,
    "plan_ai_extractions_included": 1,
    "plan_ai_tokens_included": 1,
    "plan_paid_until": "2026-10-02",
    "plan_changed_at": "2026-10-02",
    "created_at": "2026-10-02T20:24:12.209523Z",
    "updated_at": "2026-10-02T20:24:12.209622Z",
    "api_access_enabled": true
}

Request   

PATCH gestor/customers/{customer_backoffice_id}/backoffice-email

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros da URL

customer_backoffice_id   integer   

O ID do customer backoffice. Ex: 10

Parâmetros do body

account_email   string   

Deve ser um endereço de e-mail válido. Não pode ser superior a 120 caracteres. Ex: dacruz.theo@example.org

Altera a senha de um usuário de cliente.

requer autenticação

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

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

let body = {
    "password": "Senha@123"
};

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/gestor/users/10/password',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'password' => 'Senha@123',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/gestor/users/10/password'
payload = {
    "password": "Senha@123"
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Exemplo de resposta (200):


{
    "id": 1,
    "customer_id": 696,
    "name": "Sr. Alessandro Garcia Leon",
    "email": "amanda17@example.org",
    "email_verified_at": "2026-10-02T20:24:12.228876Z",
    "phone": "6325703268",
    "isolated_orders": true,
    "last_login_at": "2026-10-02T20:24:12.229221Z",
    "created_at": "2026-10-02T20:24:12.229306Z",
    "updated_at": "2026-10-02T20:24:12.229360Z",
    "free_order_summary_remaining": 1,
    "two_factor_confirmed_at": "2026-10-02T20:24:12.229412Z"
}

Request   

PATCH gestor/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

password   string   

Não pode ser superior a 255 caracteres. Ex: Senha@123

Altera o email de um usuário de cliente. Se for o primeiro usuário da conta, sincroniza também o email da conta (backoffice_email) e avisa o Backoffice externo.

requer autenticação

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

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

let body = {
    "email": "qpontes@example.org"
};

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/gestor/users/10/email',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'email' => 'qpontes@example.org',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/gestor/users/10/email'
payload = {
    "email": "qpontes@example.org"
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Exemplo de resposta (200):


{
    "id": 1,
    "customer_id": 520,
    "name": "João Gustavo Burgos Neto",
    "email": "verdugo.josefina@example.org",
    "email_verified_at": "2026-10-02T20:24:12.248444Z",
    "phone": "4320829354",
    "isolated_orders": true,
    "last_login_at": "2026-10-02T20:24:12.248668Z",
    "created_at": "2026-10-02T20:24:12.248766Z",
    "updated_at": "2026-10-02T20:24:12.248851Z",
    "free_order_summary_remaining": 1,
    "two_factor_confirmed_at": "2026-10-02T20:24:12.249001Z"
}

Request   

PATCH gestor/users/{user_id}/email

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

email   string   

Deve ser um endereço de e-mail válido. Não pode ser superior a 120 caracteres. Ex: qpontes@example.org

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": []
};

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' => [],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/groups'
payload = {
    "groups": []
}
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.

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": "Dr. Isabella Silvana Dias"
};

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' => 'Dr. Isabella Silvana Dias',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

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

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

Exemplo de resposta (200):


{
    "id": 1,
    "customer_id": 936,
    "name": "Júlia Mendes Rezende",
    "color": "exemplo",
    "created_at": "2026-10-02T20:24:12.285322Z",
    "updated_at": "2026-10-02T20:24:12.285433Z"
}

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   

Não pode ser superior a 60 caracteres. Ex: Dr. Isabella Silvana Dias

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

Grupos de usuários

GET user-groups

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/user-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/user-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/user-groups'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

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

Request   

GET user-groups

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

GET user-groups/{userGroup_id}/members

requer autenticação

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

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/user-groups/10/members',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

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

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

Request   

GET user-groups/{userGroup_id}/members

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

userGroup_id   integer   

O ID do usuárioGroup. Ex: 10

POST user-groups

requer autenticação

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

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

let body = {
    "name": "Sra. Alana Beltrão Filho",
    "description": "Numquam quod et nihil at ut iure in.",
    "parent_id": 141
};

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/user-groups',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'Sra. Alana Beltrão Filho',
            'description' => 'Numquam quod et nihil at ut iure in.',
            'parent_id' => 141,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/user-groups'
payload = {
    "name": "Sra. Alana Beltrão Filho",
    "description": "Numquam quod et nihil at ut iure in.",
    "parent_id": 141
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Exemplo de resposta (200):


{
    "id": 1,
    "customer_id": 328,
    "parent_id": 39,
    "name": "Augusto Roque Neto",
    "description": "Qui molestiae fuga quo omnis."
}

Request   

POST user-groups

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros do body

name   string   

Não pode ser superior a 255 caracteres. Ex: Sra. Alana Beltrão Filho

description   string  opcional  

Não pode ser superior a 255 caracteres. Ex: Numquam quod et nihil at ut iure in.

parent_id   integer  opcional  

Ex: 141

PUT user-groups/{userGroup_id}

requer autenticação

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

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

let body = {
    "name": "Murilo Saito Romero Neto",
    "description": "Qui pariatur perferendis quis repellat et quaerat.",
    "parent_id": 79
};

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/user-groups/10',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'Murilo Saito Romero Neto',
            'description' => 'Qui pariatur perferendis quis repellat et quaerat.',
            'parent_id' => 79,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/user-groups/10'
payload = {
    "name": "Murilo Saito Romero Neto",
    "description": "Qui pariatur perferendis quis repellat et quaerat.",
    "parent_id": 79
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Exemplo de resposta (200):


{
    "id": 1,
    "customer_id": 849,
    "parent_id": 439,
    "name": "Benício Leonardo Urias",
    "description": "Modi nesciunt modi earum non quidem qui."
}

Request   

PUT user-groups/{userGroup_id}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros da URL

userGroup_id   integer   

O ID do usuárioGroup. Ex: 10

Parâmetros do body

name   string  opcional  

Não pode ser superior a 255 caracteres. Ex: Murilo Saito Romero Neto

description   string  opcional  

Ex: Qui pariatur perferendis quis repellat et quaerat.

parent_id   integer  opcional  

Ex: 79

DELETE user-groups/{userGroup_id}

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/user-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/user-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/user-groups/10'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

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

Request   

DELETE user-groups/{userGroup_id}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

userGroup_id   integer   

O ID do usuárioGroup. Ex: 10

Adicionar um usuário a um grupo

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/user-groups/10/members/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/user-groups/10/members/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/user-groups/10/members/10'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

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

Request   

PUT user-groups/{userGroup_id}/members/{user_id}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

userGroup_id   integer   

O ID do usuárioGroup. Ex: 10

user_id   integer   

O ID do usuário. Ex: 10

Remover um usuário de um grupo

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/user-groups/10/members/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/user-groups/10/members/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/user-groups/10/members/10'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

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

Request   

DELETE user-groups/{userGroup_id}/members/{user_id}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

userGroup_id   integer   

O ID do usuárioGroup. Ex: 10

user_id   integer   

O ID do usuário. Ex: 10

Substituir os membros de um grupo

requer autenticação

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

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

let body = {
    "users_ids": [
        776,
        807
    ]
};

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/user-groups/10/members',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'users_ids' => [776, 807],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/user-groups/10/members'
payload = {
    "users_ids": [
        776,
        807
    ]
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Request   

PUT user-groups/{userGroup_id}/members

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros da URL

userGroup_id   integer   

O ID do usuárioGroup. Ex: 10

Parâmetros do body

users_ids   integer[]   

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, 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/0-9"
);

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/0-9',
    [
        '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/0-9'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

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

Exemplo de resposta (200):


{
    "id": 1,
    "service_id": 205,
    "customer_id": 334,
    "name": "Maximiano Henrique Casanova",
    "document_name": "documento.pdf",
    "created_at": "2026-10-02T20:24:11.440929Z",
    "updated_at": "2026-10-02T20:24:11.441729Z",
    "fixed_schema": true,
    "hidden_schema": true,
    "download_as_xml": true,
    "allow_multiple_files_to_be_joined": true,
    "example_html_content": "exemplo"
}

Request   

GET ai/models/{id}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

id   string   

O ID do model. Ex: 0-9

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": "Srta. Mary Salgado Dias Sobrinho",
    "document_name": "documento.pdf",
    "service_id": 280,
    "allow_multiple_files_to_be_joined": true,
    "questions": [
        {
            "question_to_send_to_ai": "Qual é o status desse pedido?",
            "label_show_user": "Meu label"
        }
    ]
};

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' => 'Srta. Mary Salgado Dias Sobrinho',
            'document_name' => 'documento.pdf',
            'service_id' => 280,
            'allow_multiple_files_to_be_joined' => true,
            'questions' => [
                ['question_to_send_to_ai' => 'Qual é o status desse pedido?', 'label_show_user' => 'Meu label'],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/ai/models'
payload = {
    "name": "Srta. Mary Salgado Dias Sobrinho",
    "document_name": "documento.pdf",
    "service_id": 280,
    "allow_multiple_files_to_be_joined": true,
    "questions": [
        {
            "question_to_send_to_ai": "Qual é o status desse pedido?",
            "label_show_user": "Meu label"
        }
    ]
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Exemplo de resposta (200):


{
    "id": 1,
    "service_id": 82,
    "customer_id": 229,
    "name": "Sr. Luan Romero",
    "document_name": "documento.pdf",
    "created_at": "2026-10-02T20:24:11.488801Z",
    "updated_at": "2026-10-02T20:24:11.488912Z",
    "fixed_schema": true,
    "hidden_schema": true,
    "download_as_xml": true,
    "allow_multiple_files_to_be_joined": true,
    "example_html_content": "exemplo"
}

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. Ex: Srta. Mary Salgado Dias Sobrinho

document_name   string  opcional  

Este campo é obrigatório quando service_id for null. Não pode ser superior a 120 caracteres. Ex: documento.pdf

service_id   integer  opcional  

Deve corresponder a um valor já cadastrado. Ex: 280

allow_multiple_files_to_be_joined   boolean   

Ex: true

questions   object[]  opcional  

Deve ter pelo menos 1 item.
question_to_send_to_ai   string   

Ex: Qual é o status desse pedido?

label_show_user   string   

Não pode ser superior a 60 caracteres. Ex: Meu label

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": "Moisés Filipe Sepúlveda",
    "document_name": "documento.pdf",
    "service_id": 379,
    "allow_multiple_files_to_be_joined": true,
    "questions": [
        {
            "question_to_send_to_ai": "Qual é o status desse pedido?",
            "label_show_user": "Meu label"
        }
    ]
};

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' => 'Moisés Filipe Sepúlveda',
            'document_name' => 'documento.pdf',
            'service_id' => 379,
            'allow_multiple_files_to_be_joined' => true,
            'questions' => [
                ['question_to_send_to_ai' => 'Qual é o status desse pedido?', 'label_show_user' => 'Meu label'],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/ai/models/10'
payload = {
    "name": "Moisés Filipe Sepúlveda",
    "document_name": "documento.pdf",
    "service_id": 379,
    "allow_multiple_files_to_be_joined": true,
    "questions": [
        {
            "question_to_send_to_ai": "Qual é o status desse pedido?",
            "label_show_user": "Meu label"
        }
    ]
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Exemplo de resposta (200):


{
    "id": 1,
    "service_id": 304,
    "customer_id": 33,
    "name": "Everton Saraiva Bezerra",
    "document_name": "documento.pdf",
    "created_at": "2026-10-02T20:24:11.518533Z",
    "updated_at": "2026-10-02T20:24:11.518646Z",
    "fixed_schema": true,
    "hidden_schema": true,
    "download_as_xml": true,
    "allow_multiple_files_to_be_joined": true,
    "example_html_content": "exemplo"
}

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. Ex: Moisés Filipe Sepúlveda

document_name   string  opcional  

Este campo é obrigatório quando service_id for null. Não pode ser superior a 120 caracteres. Ex: documento.pdf

service_id   integer  opcional  

Deve corresponder a um valor já cadastrado. Ex: 379

allow_multiple_files_to_be_joined   boolean   

Ex: true

questions   object[]  opcional  

Deve ter pelo menos 1 item.
question_to_send_to_ai   string   

Ex: Qual é o status desse pedido?

label_show_user   string   

Não pode ser superior a 60 caracteres. Ex: Meu label

Excluir um modelo de IA

requer autenticação

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

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/exemplo',
    [
        '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/exemplo'
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: exemplo

Retorna os dados de uma conversa com a IA

requer autenticação Disponível apenas para clientes pós pagos (Com contrato)

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/ai/conversations/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/conversations/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/conversations/10'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

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

Exemplo de resposta (200):


{
    "id": 1,
    "name": "Sr. Gian Guilherme Abreu Sobrinho",
    "user_id": 199,
    "order_id": 775,
    "origin": "chatbot",
    "finished_at": "2026-10-02T20:24:11.546522Z",
    "created_at": "2026-10-02T20:24:11.546661Z",
    "is_running": true,
    "total_tokens": 1,
    "deleted_at": "2026-10-02T20:24:11.546785Z"
}

Request   

GET ai/conversations/{aiConversation_id}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

aiConversation_id   integer   

O ID do aiConversation. 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, order, order_count, orderExists, messages_count

append   string  opcional  

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

filter   array  opcional  

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

Deletar uma conversa com a IA

requer autenticação Disponível apenas para clientes pós pagos (Com contrato)

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/ai/conversations/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/ai/conversations/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/conversations/10'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

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

Request   

DELETE ai/conversations/{aiConversation_id}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

aiConversation_id   integer   

O ID do aiConversation. Ex: 10

Listar as conversas de IA iniciadas pelo usuário

requer autenticação Disponível apenas para clientes pós pagos (Com contrato)

O retorno é paginado

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

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/conversations',
    [
        '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/conversations'
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/conversations

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, order, order_count, orderExists, 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

filter   array  opcional  

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

Inicia uma nova conversa com a IA

requer autenticação Disponível apenas para clientes pós pagos (Com contrato)

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

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

let body = {
    "name": "Cynthia Barros",
    "order_id": 540
};

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/conversations',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'Cynthia Barros',
            'order_id' => 540,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/ai/conversations'
payload = {
    "name": "Cynthia Barros",
    "order_id": 540
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Exemplo de resposta (200):


{
    "id": 1,
    "name": "Dr. Caio Júlio Leon",
    "user_id": 730,
    "order_id": 726,
    "origin": "chatbot",
    "finished_at": "2026-10-02T20:24:11.576509Z",
    "created_at": "2026-10-02T20:24:11.576613Z",
    "is_running": true,
    "total_tokens": 1,
    "deleted_at": "2026-10-02T20:24:11.576681Z"
}

Request   

POST ai/conversations

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros do body

name   string   

Não pode ser superior a 50 caracteres. Ex: Cynthia Barros

order_id   integer  opcional  

Ex: 540

Adiciona uma mensagem em uma conversa existente com a IA

requer autenticação Disponível apenas para clientes pós pagos (Com contrato)

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

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

let body = {
    "message": "Quaerat autem nisi qui aut et odio aspernatur.",
    "files_ids": [
        712,
        744
    ]
};

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/conversations/10/messages',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'message' => 'Quaerat autem nisi qui aut et odio aspernatur.',
            'files_ids' => [712, 744],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/ai/conversations/10/messages'
payload = {
    "message": "Quaerat autem nisi qui aut et odio aspernatur.",
    "files_ids": [
        712,
        744
    ]
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Exemplo de resposta (200):


{
    "id": 1,
    "ai_conversation_id": 434,
    "send_by": "exemplo",
    "message": "Doloremque sequi occaecati id modi est.",
    "created_at": "2026-10-02T20:24:11.597951Z",
    "files_ids": [
        490,
        546
    ]
}

Request   

POST ai/conversations/{aiConversation_id}/messages

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros da URL

aiConversation_id   integer   

O ID do aiConversation. Ex: 10

Parâmetros do body

message   string   

Ex: Quaerat autem nisi qui aut et odio aspernatur.

files_ids   string[]  opcional  

Adiciona uma mensagem em uma conversa existente com a IA

requer autenticação Disponível apenas para clientes pós pagos (Com contrato)

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/ai/conversations/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/conversations/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/conversations/10/messages'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

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

Request   

GET ai/conversations/{aiConversation_id}/messages

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

aiConversation_id   integer   

O ID do aiConversation. Ex: 10

Registra feedback do usuário para uma mensagem da conversa

requer autenticação Disponível apenas para clientes pós pagos (Com contrato)

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

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/ai/conversations/10/messages/10/feedback/',
    [
        '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/conversations/10/messages/10/feedback/'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

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

Request   

PUT ai/conversations/{aiConversation_id}/messages/{aiMessage_id}/feedback/{feedback}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

aiConversation_id   integer   

O ID do aiConversation. Ex: 10

aiMessage_id   integer   

O ID do aiMessage. Ex: 10

feedback   string   

The feedback.Deve ser um destes:

  • positive
  • negative

Atualiza o nome da conversa com a IA

requer autenticação Disponível apenas para clientes pós pagos (Com contrato)

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

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

let body = {
    "name": "Srta. Naomi Rangel Alcantara"
};

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/ai/conversations/10/name',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'Srta. Naomi Rangel Alcantara',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/ai/conversations/10/name'
payload = {
    "name": "Srta. Naomi Rangel Alcantara"
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Request   

PATCH ai/conversations/{aiConversation_id}/name

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros da URL

aiConversation_id   integer   

O ID do aiConversation. Ex: 10

Parâmetros do body

name   string   

Não pode ser superior a 50 caracteres. Ex: Srta. Naomi Rangel Alcantara

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

requer autenticação Disponível apenas para clientes pós pagos (Com contrato)

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/conversations/files"
);

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

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

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

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

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

Request   

POST ai/conversations/files

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: multipart/form-data

Parâmetros do body

files   string[]   

Não pode ser superior a 71680 caracteres.

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, 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, challenges, challenges_count, challengesExists, 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, result_details, 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, finished_at

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, valid_until_between, status, service_id, group_id, user_id, purchase.recurrence_id, ai, purchase_id, ocr_content, expired, has_active_challenge, recurrence_generated, has_extracted_summary, originated_from_id, person_document, detailed_service_data.modelo_ia_id

Visualizar um item de compra

requer autenticação

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

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/0-9',
    [
        '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/0-9'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

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

Exemplo de resposta (200):


{
    "id": 1,
    "backoffice_code": "6620985",
    "purchase_id": 484,
    "status": "creating",
    "user_id": 918,
    "customer_id": 379,
    "service_id": 553,
    "name": "Joaquin Solano",
    "register": "exemplo",
    "person_document": "exemplo",
    "result": "positive",
    "location_info": [],
    "placed_at": "2026-10-02T20:24:12.502346Z",
    "detailed_service_data": [],
    "custom_fields": [],
    "verification_code": "cq-7965",
    "estimated_at": "2026-10-02T20:24:12.502590Z",
    "finished_at": "2026-10-02T20:24:12.502648Z",
    "status_details": "Et alias iste voluptas at asperiores quasi iste quae.",
    "annotations": "Eaque expedita dolore deleniti et consequuntur id.",
    "backoffice_detailed_service_fulfillment_data": [],
    "total_cost": 196.43,
    "total_estimated_cost_postpaid_customer": 1.5,
    "included_in_plan": 1,
    "provider_fee": 1.5,
    "file_preview_url": "http://www.pacheco.com.br/expedita-rerum-explicabo-consequatur-magni",
    "comments": "exemplo",
    "valid_until": "2026-10-02",
    "originated_from_id": 222,
    "auto_purchase_certificate_from_result_positive": true,
    "auto_purchase_certificate_from_result_negative": true,
    "last_status_change_at": "2026-10-02T20:24:12.503456Z",
    "created_at": "2026-10-02T20:24:12.503531Z",
    "updated_at": "2026-10-02T20:24:12.503569Z",
    "imported_at": "2026-10-02T20:24:12.503610Z",
    "extracted_summary": [],
    "recurrence_item_id": 536,
    "is_chain_complete": true,
    "file_id_vector_store": "exemplo",
    "backoffice_hash": "exemplo",
    "automatic_purchase_observations": "exemplo"
}

Request   

GET orders/{id}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

id   integer   

O ID do item de compra. Ex: 0-9

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, 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, challenges, challenges_count, challengesExists, 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, result_details, 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, valid_until_between, status, service_id, group_id, user_id, purchase.recurrence_id, ai, purchase_id, ocr_content, expired, has_active_challenge, recurrence_generated, has_extracted_summary, originated_from_id, person_document, detailed_service_data.modelo_ia_id

Filtrar e paginar os resultados detalhados de um pedido

requer autenticação

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

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/0-9/result-details',
    [
        '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/0-9/result-details'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

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

Request   

GET orders/{id}/result-details

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

id   integer   

O ID do item de compra. Ex: 0-9

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, 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, challenges, challenges_count, challengesExists, 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, result_details, 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, valid_until_between, status, service_id, group_id, user_id, purchase.recurrence_id, ai, purchase_id, ocr_content, expired, has_active_challenge, recurrence_generated, has_extracted_summary, originated_from_id, person_document, detailed_service_data.modelo_ia_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": "Demian Alcantara"
};

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' => 'Demian Alcantara',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/orders/10/name'
payload = {
    "name": "Demian Alcantara"
}
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. Ex: Demian Alcantara

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}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "groups_ids": [
        354,
        970
    ]
};

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/10/groups',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'groups_ids' => [354, 970],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

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

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

Request   

PUT orders/{order_id}/groups

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

groups_ids   integer[]  opcional  

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": "Molestiae optio sed ut aliquam tenetur quia."
};

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' => 'Molestiae optio sed ut aliquam tenetur quia.',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/orders/10/annotation'
payload = {
    "annotations": "Molestiae optio sed ut aliquam tenetur quia."
}
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. Ex: Molestiae optio sed ut aliquam tenetur quia.

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": "link",
    "destination_email": "renato.sandoval@example.com"
};

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' => 'link',
            'destination_email' => 'renato.sandoval@example.com',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

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

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

Exemplo de resposta (200):


{
    "order_id": 961,
    "shared_by_user_id": 390,
    "expiration_at": "2026-10-02T20:24:12.611310Z",
    "via": "link",
    "generated_link": "exemplo",
    "destination_email": "matias.luna@example.org",
    "created_at": "2026-10-02T20:24:12.611660Z",
    "updated_at": "2026-10-02T20:24:12.611729Z"
}

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   

Ex: link

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

Este campo é obrigatório quando via for email. Deve ser um endereço de e-mail válido. Ex: renato.sandoval@example.com

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()

Exemplo de resposta (200):


{
    "file_path": "exemplo",
    "download_name": "exemplo"
}

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 headers = {
    "Authorization": "Bearer {SEU TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "group_by": "purchase"
};

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/orders/123,456,789/download',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'group_by' => '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'
payload = {
    "group_by": "purchase"
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Request   

GET orders/{ids}/download

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros da URL

ids   string   

Ex: 123,456,789

Parâmetros do body

group_by   string  opcional  

Ex: purchase

Deve ser um destes:
  • purchase
  • register

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}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "subject": "Quaerat at optio.",
    "description": "Aliquam pariatur cumque non et sequi quam nulla."
};

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/problem',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'subject' => 'Quaerat at optio.',
            'description' => 'Aliquam pariatur cumque non et sequi quam nulla.',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/orders/10/problem'
payload = {
    "subject": "Quaerat at optio.",
    "description": "Aliquam pariatur cumque non et sequi quam nulla."
}
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}/problem

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

subject   string  opcional  

Não pode ser superior a 75 caracteres. Ex: Quaerat at optio.

description   string  opcional  

Não pode ser superior a 32000 caracteres. Ex: Aliquam pariatur cumque non et sequi quam nulla.

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 = {
    "description": "Ut quis voluptatum et.",
    "files": [
        "exemplo"
    ]
};

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' => [
            'description' => 'Ut quis voluptatum et.',
            'files' => ['exemplo'],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/orders/10/additional-information'
payload = {
    "description": "Ut quis voluptatum et.",
    "files": [
        "exemplo"
    ]
}
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

description   string   

Não pode ser superior a 2000 caracteres. Ex: Ut quis voluptatum et.

files   string[]   

Não pode ser superior a 71680 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[]', 'exemplo');

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' => 'exemplo'
            ],
        ],
    ]
);
$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, 'exemplo')}
payload = {
    "files": [
        "exemplo"
    ]
}
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   file[]   

Deve ser um arquivo. Não pode ser superior a 70000 kilobytes.

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}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "valid_until": "1986-10-05"
};

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/valid-until',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'valid_until' => '1986-10-05',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/orders/10/valid-until'
payload = {
    "valid_until": "1986-10-05"
}
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}/valid-until

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

valid_until   string  opcional  

Deve ser uma data válida no formato Y-m-d. Ex: 1986-10-05

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": 834,
    "detailed_service_data": []
};

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' => 834,
            'detailed_service_data' => [],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/orders/similar'
payload = {
    "service_id": 834,
    "detailed_service_data": []
}
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 Ex: 834

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": 696
        }
    ]
};

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' => 696],
            ],
        ],
    ]
);
$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": 696
        }
    ]
}
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   

Must match an existing stored value. Ex: 696

Visualizar o histórico detalhado de um item de compra

requer autenticação

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

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/history',
    [
        '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/history'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

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

Request   

GET orders/{order_id}/history

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

order_id   integer   

O ID do item de compra. Ex: 10

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}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "groups_ids": [
        123,
        283
    ]
};

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/purchases/10/groups',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'groups_ids' => [123, 283],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

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

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

Request   

PUT purchases/{purchase_id}/groups

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[]  opcional  

Mapa de relacionamentos de empresas

GET company-relationship-map/company/{cnpj}

requer autenticação Disponível apenas para clientes pós pagos (Com contrato)

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

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/company-relationship-map/company/24979227000199',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/company-relationship-map/company/24979227000199'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

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

Exemplo de resposta (200):


{
    "cnpj": "23615926000197",
    "corporate_name": "D'ávila Comercial Ltda.",
    "trade_name": "exemplo",
    "registration_status": "exemplo",
    "main_activity_code": "vk-0190",
    "main_activity_description": "exemplo",
    "federative_unit_abbr": "exemplo",
    "city": "Tessália d'Oeste",
    "social_capital": "exemplo",
    "legal_nature": "exemplo",
    "size": "exemplo",
    "opening_date": "1973-06-07",
    "emails": [],
    "partners": "exemplo"
}

Request   

GET company-relationship-map/company/{cnpj}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

cnpj   string   

Ex: 24979227000199

GET company-relationship-map/company/{cnpj}/graph

requer autenticação Disponível apenas para clientes pós pagos (Com contrato)

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/company-relationship-map/company/10548777000149/graph"
);

const params = {
    "layers": "1",
};
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 = {
    "layers": 2
};

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/company-relationship-map/company/10548777000149/graph',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'query' => [
            'layers' => '1',
        ],
        'json' => [
            'layers' => 2,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/company-relationship-map/company/10548777000149/graph'
payload = {
    "layers": 2
}
params = {
  'layers': '1',
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Exemplo de resposta (200):


{
    "nodes": [],
    "edges": []
}

Request   

GET company-relationship-map/company/{cnpj}/graph

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros da URL

cnpj   string   

Ex: 10548777000149

Parâmetros da query

layers   integer  opcional  

Profundidade da expansão. Cada camada traz vínculos indiretos (sócios das empresas, outras empresas dos sócios, etc). Mínimo 1, máximo 3. Padrão: 1. Ex: 1

Parâmetros do body

layers   integer  opcional  

Deve ser pelo menos 1. Não pode ser superior a 3. Ex: 2

GET company-relationship-map/person/{cpf}/graph

requer autenticação Disponível apenas para clientes pós pagos (Com contrato)

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/company-relationship-map/person/48604454578/graph"
);

const params = {
    "layers": "1",
};
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 = {
    "layers": 2
};

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/company-relationship-map/person/48604454578/graph',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'query' => [
            'layers' => '1',
        ],
        'json' => [
            'layers' => 2,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/company-relationship-map/person/48604454578/graph'
payload = {
    "layers": 2
}
params = {
  'layers': '1',
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Exemplo de resposta (200):


{
    "nodes": [],
    "edges": []
}

Request   

GET company-relationship-map/person/{cpf}/graph

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros da URL

cpf   string   

Ex: 48604454578

Parâmetros da query

layers   integer  opcional  

Profundidade da expansão. Cada camada traz vínculos indiretos (sócios das empresas, outras empresas dos sócios, etc). Mínimo 1, máximo 3. Padrão: 1. Ex: 1

Parâmetros do body

layers   integer  opcional  

Deve ser pelo menos 1. Não pode ser superior a 3. Ex: 2

Retorna a(s) pessoa(s) associada(s) a um CPF (ou miolo) e as empresas em que participam, direto da base da Receita, sem custo de enriquecimento.

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/company-relationship-map/person/38178579693/companies"
);

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/company-relationship-map/person/38178579693/companies',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/company-relationship-map/person/38178579693/companies'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

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

Exemplo de resposta (200):


{
    "cpf_core": "exemplo",
    "total": 1,
    "notice": "exemplo",
    "people": "exemplo"
}

Request   

GET company-relationship-map/person/{cpf}/companies

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

cpf   string   

Ex: 38178579693

Enriquece os dados de uma pessoa a partir de um nó do grafo (id do nó + CNPJ de origem), resolvendo a identidade na fonte complementar.

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/company-relationship-map/person/by-node"
);

const params = {
    "node_id": "PF_***331209**-CARLOS M. VIEIRA",
    "cnpj_origin": "44555666000190",
};
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 = {
    "node_id": 586,
    "cnpj_origin": "exemplo"
};

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/company-relationship-map/person/by-node',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'query' => [
            'node_id' => 'PF_***331209**-CARLOS M. VIEIRA',
            'cnpj_origin' => '44555666000190',
        ],
        'json' => [
            'node_id' => 586,
            'cnpj_origin' => 'exemplo',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/company-relationship-map/person/by-node'
payload = {
    "node_id": 586,
    "cnpj_origin": "exemplo"
}
params = {
  'node_id': 'PF_***331209**-CARLOS M. VIEIRA',
  'cnpj_origin': '44555666000190',
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Exemplo de resposta (200):


{
    "state": "enriched",
    "message": "Odio quod corrupti voluptatem sed ratione in.",
    "package": {
        "identification": {
            "name": "Dr. Elias Ferraz Cordeiro Filho",
            "cpf_status": "exemplo",
            "age": 1
        },
        "contacts": {
            "phones": [],
            "emails": [],
            "addresses": []
        },
        "related_people": "exemplo",
        "links": "exemplo",
        "cpf_masked": "exemplo",
        "cpf_unmasked": "exemplo",
        "enriched_at": "1984-10-29"
    },
    "cache": true,
    "person_key": "exemplo",
    "can_reveal": true
}

Request   

GET company-relationship-map/person/by-node

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros da query

node_id   string  opcional  

ID interno do nó de pessoa, como veio do grafo/busca. Ex: PF_***331209**-CARLOS M. VIEIRA

cnpj_origin   string  opcional  

CNPJ em que a pessoa aparece como sócia (origem da resolução). Ex: 44555666000190

Parâmetros do body

node_id   string   

Deve atender a regex /\^PF_.+/. Ex: 586

cnpj_origin   string   

Ex: exemplo

Enriquece os dados de uma pessoa a partir do CPF completo (contatos, idade, situação do CPF, pessoas relacionadas e vínculos).

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/company-relationship-map/person/52576962319"
);

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/company-relationship-map/person/52576962319',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/company-relationship-map/person/52576962319'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

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

Exemplo de resposta (200):


{
    "state": "enriched",
    "message": "Unde ipsum illum ab deserunt.",
    "package": {
        "identification": {
            "name": "Ricardo Lovato Santana Jr.",
            "cpf_status": "exemplo",
            "age": 1
        },
        "contacts": {
            "phones": [],
            "emails": [],
            "addresses": []
        },
        "related_people": "exemplo",
        "links": "exemplo",
        "cpf_masked": "exemplo",
        "cpf_unmasked": "exemplo",
        "enriched_at": "1997-02-10"
    },
    "cache": true,
    "person_key": "exemplo",
    "can_reveal": true
}

Request   

GET company-relationship-map/person/{cpf}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

cpf   string   

Ex: 52576962319

GET company-relationship-map/graph/node/{nodeId}/expand

requer autenticação Disponível apenas para clientes pós pagos (Com contrato)

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/company-relationship-map/graph/node/10/expand"
);

const params = {
    "layers": "1",
};
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 = {
    "layers": 2
};

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/company-relationship-map/graph/node/10/expand',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'query' => [
            'layers' => '1',
        ],
        'json' => [
            'layers' => 2,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/company-relationship-map/graph/node/10/expand'
payload = {
    "layers": 2
}
params = {
  'layers': '1',
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Exemplo de resposta (200):


{
    "nodes": [],
    "edges": []
}

Request   

GET company-relationship-map/graph/node/{nodeId}/expand

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros da URL

nodeId   string   

Ex: 10

Parâmetros da query

layers   integer  opcional  

Profundidade da expansão. Cada camada traz vínculos indiretos. Mínimo 1, máximo 3. Padrão: 1. Ex: 1

Parâmetros do body

layers   integer  opcional  

Deve ser pelo menos 1. Não pode ser superior a 3. Ex: 2

requer autenticação Disponível apenas para clientes pós pagos (Com contrato)

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

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

let body = {
    "query": "maxime",
    "type": "company",
    "situation": "active"
};

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/company-relationship-map/search',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'query' => 'maxime',
            'type' => 'company',
            'situation' => 'active',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/company-relationship-map/search'
payload = {
    "query": "maxime",
    "type": "company",
    "situation": "active"
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Exemplo de resposta (200):


{
    "results": []
}

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, children.service, children.owner, 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/0-9"
);

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/0-9',
    [
        '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/0-9'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

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

Exemplo de resposta (200):


{
    "id": 1,
    "owner_id": 420,
    "customer_id": 101,
    "parent_id": 767,
    "order_id": 151,
    "name": "Sra. Dirce Camacho",
    "created_at": "2026-10-02T20:24:12.054952Z",
    "type": "folder",
    "last_operation_at": "2026-10-02T20:24:12.055356Z",
    "file_size_bytes": 1,
    "ocr_requested_at": "2026-10-02T20:24:12.055525Z",
    "service_id": 684,
    "ai_input_type": "file",
    "ai_request_pending": true,
    "updated_at": "2026-10-02T20:24:12.055799Z",
    "ocr_failed": true,
    "ocr_available": true,
    "file_id_vector_store": "exemplo"
}

Request   

GET explorer/{id}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

id   string   

O ID do explorer. Ex: 0-9

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, children.service, children.owner, 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}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "groups_ids": [
        730,
        450
    ]
};

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/explorer/10/groups',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'groups_ids' => [730, 450],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

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

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

Request   

PUT explorer/{explorerItem_id}/groups

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

groups_ids   integer[]  opcional  

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}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "service_id": 842
};

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/service',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'service_id' => 842,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/explorer/10/service'
payload = {
    "service_id": 842
}
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}/service

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

service_id   integer  opcional  

Deve corresponder a um valor já cadastrado. Ex: 842

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": "Sr. Ivan Cordeiro Filho"
};

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' => 'Sr. Ivan Cordeiro Filho',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/explorer/10/name'
payload = {
    "name": "Sr. Ivan Cordeiro Filho"
}
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. Ex: Sr. Ivan Cordeiro Filho

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": "uploaded_file",
};
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": "Dr. Naomi Louise Rios"
};

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' => 'uploaded_file',
        ],
        'json' => [
            'name' => 'Dr. Naomi Louise Rios',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

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

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

Exemplo de resposta (200):


{
    "id": 1,
    "owner_id": 615,
    "customer_id": 468,
    "parent_id": 963,
    "order_id": 14,
    "name": "Nicolas Saito Faria",
    "created_at": "2026-10-02T20:24:12.144370Z",
    "type": "folder",
    "last_operation_at": "2026-10-02T20:24:12.144541Z",
    "file_size_bytes": 1,
    "ocr_requested_at": "2026-10-02T20:24:12.144676Z",
    "service_id": 540,
    "ai_input_type": "file",
    "ai_request_pending": true,
    "updated_at": "2026-10-02T20:24:12.144816Z",
    "ocr_failed": true,
    "ocr_available": true,
    "file_id_vector_store": "exemplo"
}

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: uploaded_file

Parâmetros do body

name   string   

Não pode ser superior a 120 caracteres. Ex: Dr. Naomi Louise Rios

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": "directory",
};
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 = {
    "group_by": "purchase"
};

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/explorer/123,456,789/download',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'query' => [
            'groupBy' => 'directory',
        ],
        'json' => [
            'group_by' => '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'
payload = {
    "group_by": "purchase"
}
params = {
  'groupBy': 'directory',
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Request   

GET explorer/{ids}/download

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

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: directory

Parâmetros do body

group_by   string   

Ex: purchase

Deve ser um destes:
  • purchase
  • register
  • directory

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[]', 'exemplo');
body.append('parent_id', '873');
body.append('service_id', '103');
body.append('groups_ids[]', '755');

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' => 'exemplo'
            ],
            [
                'name' => 'parent_id',
                'contents' => '873'
            ],
            [
                'name' => 'service_id',
                'contents' => '103'
            ],
            [
                'name' => 'groups_ids[]',
                'contents' => '755'
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/explorer/upload'
files = {
  'files[]': (None, 'exemplo'),
  'parent_id': (None, '873'),
  'service_id': (None, '103'),
  'groups_ids[]': (None, '755')}
payload = {
    "files": [
        "exemplo"
    ],
    "parent_id": 873,
    "service_id": 103,
    "groups_ids": [
        755,
        210
    ]
}
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[]   

Não pode ser superior a 71680 caracteres.

parent_id   integer  opcional  

Ex: 873

service_id   integer  opcional  

Deve corresponder a um valor já cadastrado. Ex: 103

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/exemplo/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/exemplo/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/exemplo/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: exemplo

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 uma notificação do usuário como lida

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/notifications/exemplo/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/exemplo/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/exemplo/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: exemplo

Marca uma notificação do usuário como não lida

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/notifications/exemplo/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/exemplo/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/exemplo/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: exemplo

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/exemplo"
);

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/exemplo',
    [
        '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/exemplo'
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: exemplo

Outros

Consulta dados de uma empresa pelo cnpj

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



fetch(url, {
    method: "GET",
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get('https://api2.cbrdoc.com.br/person-data-by-cpf/07684237241');
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/person-data-by-cpf/07684237241'
response = requests.request('GET', url, )
response.json()

Exemplo de resposta (200):


{
    "valid": true,
    "name": "Srta. Manoela da Silva",
    "gender": "exemplo",
    "age": 1,
    "mother_name": "exemplo",
    "father_name": "exemplo",
    "nationality": "exemplo"
}

Request   

GET person-data-by-cpf/{cpf}

Parâmetros da URL

cpf   string   

Ex: 07684237241

Indica se a API está disponível

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



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

url = 'https://api2.cbrdoc.com.br/health'
response = requests.request('GET', url, )
response.json()

Request   

GET health

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/0-9"
);

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/0-9',
    [
        '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/0-9'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

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

Exemplo de resposta (200):


{
    "id": 1,
    "name": "Rogério Santos Toledo",
    "keep_original_groups_from_items": 1,
    "starts_at": "2026-10-02",
    "next_at": "2026-10-02",
    "last_at": "2026-10-02",
    "frequency": "weekly",
    "monthly_day_of_month": 1,
    "weekly_happens_on": [],
    "yearly_month": 1,
    "yearly_day": 1,
    "owner_id": 344,
    "customer_id": 539,
    "active": true,
    "every_x_days_number_of_days": 1,
    "specific_time": "14:30",
    "created_at": "2026-10-02T20:24:13.011612Z",
    "updated_at": "2026-10-02T20:24:13.011709Z",
    "notify_result_changes_in_items": 1
}

Request   

GET recurrences/{id}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

id   integer   

O ID da recorrência. Ex: 0-9

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": "Dr. Thales Enzo Dias",
    "starts_at": "2006-01-14",
    "frequency": "weekly",
    "monthly_day_of_month": 16,
    "yearly_day": 16,
    "yearly_month": 7,
    "weekly_happens_on": [],
    "every_x_days_number_of_days": 1,
    "specific_time": "14:30",
    "items": [],
    "groups_ids": [
        808,
        801
    ],
    "notify_result_changes_in_items": true
};

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' => 'Dr. Thales Enzo Dias',
            'starts_at' => '2006-01-14',
            'frequency' => 'weekly',
            'monthly_day_of_month' => 16,
            'yearly_day' => 16,
            'yearly_month' => 7,
            'weekly_happens_on' => [],
            'every_x_days_number_of_days' => 1,
            'specific_time' => '14:30',
            'items' => [],
            'groups_ids' => [808, 801],
            'notify_result_changes_in_items' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/recurrences'
payload = {
    "name": "Dr. Thales Enzo Dias",
    "starts_at": "2006-01-14",
    "frequency": "weekly",
    "monthly_day_of_month": 16,
    "yearly_day": 16,
    "yearly_month": 7,
    "weekly_happens_on": [],
    "every_x_days_number_of_days": 1,
    "specific_time": "14:30",
    "items": [],
    "groups_ids": [
        808,
        801
    ],
    "notify_result_changes_in_items": true
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Exemplo de resposta (200):


{
    "id": 1,
    "name": "Sra. Sarah Serrano Azevedo Jr.",
    "keep_original_groups_from_items": 1,
    "starts_at": "2026-10-02",
    "next_at": "2026-10-02",
    "last_at": "2026-10-02",
    "frequency": "weekly",
    "monthly_day_of_month": 1,
    "weekly_happens_on": [],
    "yearly_month": 1,
    "yearly_day": 1,
    "owner_id": 859,
    "customer_id": 785,
    "active": true,
    "every_x_days_number_of_days": 1,
    "specific_time": "14:30",
    "created_at": "2026-10-02T20:24:13.035902Z",
    "updated_at": "2026-10-02T20:24:13.036130Z",
    "notify_result_changes_in_items": 1
}

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. Ex: Dr. Thales Enzo Dias

starts_at   string   

Deve ser uma data válida no formato Y-m-d. Deve ser uma data posterior a hoje. Ex: 2006-01-14

frequency   string   

Ex: weekly

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

Este campo é obrigatório quando frequency for monthly. Deve ser entre 1 e 31. Ex: 16

yearly_day   integer  opcional  

Este campo é obrigatório quando frequency for yearly. Deve ser entre 1 e 31. Ex: 16

yearly_month   integer  opcional  

Este campo é obrigatório quando frequency for yearly. Deve ser entre 1 e 12. Ex: 7

weekly_happens_on   object  opcional  

Este campo é obrigatório quando frequency for weekly. Não pode ter mais do que 7 itens.

every_x_days_number_of_days   integer  opcional  

Este campo é obrigatório quando frequency for every_x_days. Deve ser pelo menos 1. Ex: 1

specific_time   string  opcional  

Deve ser uma data válida no formato H:i. Ex: 14:30

items   object  opcional  
groups_ids   integer[]  opcional  
notify_result_changes_in_items   boolean   

Ex: true

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": "Lara Ortiz Reis Neto",
    "starts_at": "2004-10-24",
    "frequency": "weekly",
    "monthly_day_of_month": 16,
    "yearly_day": 16,
    "yearly_month": 7,
    "weekly_happens_on": [],
    "every_x_days_number_of_days": 1,
    "specific_time": "14:30",
    "purchase_id": 615,
    "groups_ids": [
        215,
        670
    ],
    "notify_result_changes_in_items": true
};

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' => 'Lara Ortiz Reis Neto',
            'starts_at' => '2004-10-24',
            'frequency' => 'weekly',
            'monthly_day_of_month' => 16,
            'yearly_day' => 16,
            'yearly_month' => 7,
            'weekly_happens_on' => [],
            'every_x_days_number_of_days' => 1,
            'specific_time' => '14:30',
            'purchase_id' => 615,
            'groups_ids' => [215, 670],
            'notify_result_changes_in_items' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/recurrences/by-purchase'
payload = {
    "name": "Lara Ortiz Reis Neto",
    "starts_at": "2004-10-24",
    "frequency": "weekly",
    "monthly_day_of_month": 16,
    "yearly_day": 16,
    "yearly_month": 7,
    "weekly_happens_on": [],
    "every_x_days_number_of_days": 1,
    "specific_time": "14:30",
    "purchase_id": 615,
    "groups_ids": [
        215,
        670
    ],
    "notify_result_changes_in_items": true
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Exemplo de resposta (200):


{
    "id": 1,
    "name": "Sr. Thomas Casanova Neto",
    "keep_original_groups_from_items": 1,
    "starts_at": "2026-10-02",
    "next_at": "2026-10-02",
    "last_at": "2026-10-02",
    "frequency": "weekly",
    "monthly_day_of_month": 1,
    "weekly_happens_on": [],
    "yearly_month": 1,
    "yearly_day": 1,
    "owner_id": 43,
    "customer_id": 175,
    "active": true,
    "every_x_days_number_of_days": 1,
    "specific_time": "14:30",
    "created_at": "2026-10-02T20:24:13.055733Z",
    "updated_at": "2026-10-02T20:24:13.055827Z",
    "notify_result_changes_in_items": 1
}

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. Ex: Lara Ortiz Reis Neto

starts_at   string   

Deve ser uma data válida no formato Y-m-d. Deve ser uma data posterior a hoje. Ex: 2004-10-24

frequency   string   

Ex: weekly

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

Este campo é obrigatório quando frequency for monthly. Deve ser entre 1 e 31. Ex: 16

yearly_day   integer  opcional  

Este campo é obrigatório quando frequency for yearly. Deve ser entre 1 e 31. Ex: 16

yearly_month   integer  opcional  

Este campo é obrigatório quando frequency for yearly. Deve ser entre 1 e 12. Ex: 7

weekly_happens_on   object  opcional  

Este campo é obrigatório quando frequency for weekly. Não pode ter mais do que 7 itens.

every_x_days_number_of_days   integer  opcional  

Este campo é obrigatório quando frequency for every_x_days. Deve ser pelo menos 1. Ex: 1

specific_time   string  opcional  

Deve ser uma data válida no formato H:i. Ex: 14:30

purchase_id   integer   

Ex: 615

groups_ids   integer[]  opcional  
notify_result_changes_in_items   boolean   

Ex: true

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": "Noel Beltrão Pedrosa Filho",
    "starts_at": "1989-05-24",
    "frequency": "weekly",
    "monthly_day_of_month": 16,
    "yearly_day": 16,
    "yearly_month": 7,
    "weekly_happens_on": [],
    "every_x_days_number_of_days": 1,
    "specific_time": "14:30",
    "items": [],
    "groups_ids": [
        265,
        15
    ],
    "notify_result_changes_in_items": true
};

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' => 'Noel Beltrão Pedrosa Filho',
            'starts_at' => '1989-05-24',
            'frequency' => 'weekly',
            'monthly_day_of_month' => 16,
            'yearly_day' => 16,
            'yearly_month' => 7,
            'weekly_happens_on' => [],
            'every_x_days_number_of_days' => 1,
            'specific_time' => '14:30',
            'items' => [],
            'groups_ids' => [265, 15],
            'notify_result_changes_in_items' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/recurrences/10'
payload = {
    "name": "Noel Beltrão Pedrosa Filho",
    "starts_at": "1989-05-24",
    "frequency": "weekly",
    "monthly_day_of_month": 16,
    "yearly_day": 16,
    "yearly_month": 7,
    "weekly_happens_on": [],
    "every_x_days_number_of_days": 1,
    "specific_time": "14:30",
    "items": [],
    "groups_ids": [
        265,
        15
    ],
    "notify_result_changes_in_items": true
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Exemplo de resposta (200):


{
    "id": 1,
    "name": "Elizabeth Elaine Montenegro Jr.",
    "keep_original_groups_from_items": 1,
    "starts_at": "2026-10-02",
    "next_at": "2026-10-02",
    "last_at": "2026-10-02",
    "frequency": "weekly",
    "monthly_day_of_month": 1,
    "weekly_happens_on": [],
    "yearly_month": 1,
    "yearly_day": 1,
    "owner_id": 338,
    "customer_id": 966,
    "active": true,
    "every_x_days_number_of_days": 1,
    "specific_time": "14:30",
    "created_at": "2026-10-02T20:24:13.079282Z",
    "updated_at": "2026-10-02T20:24:13.079381Z",
    "notify_result_changes_in_items": 1
}

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. Ex: Noel Beltrão Pedrosa Filho

starts_at   string   

Deve ser uma data válida no formato Y-m-d. Deve ser uma data posterior a hoje. Ex: 1989-05-24

frequency   string   

Ex: weekly

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

Este campo é obrigatório quando frequency for monthly. Deve ser entre 1 e 31. Ex: 16

yearly_day   integer  opcional  

Este campo é obrigatório quando frequency for yearly. Deve ser entre 1 e 31. Ex: 16

yearly_month   integer  opcional  

Este campo é obrigatório quando frequency for yearly. Deve ser entre 1 e 12. Ex: 7

weekly_happens_on   object  opcional  

Este campo é obrigatório quando frequency for weekly. Não pode ter mais do que 7 itens.

every_x_days_number_of_days   integer  opcional  

Este campo é obrigatório quando frequency for every_x_days. Deve ser pelo menos 1. Ex: 1

specific_time   string  opcional  

Deve ser uma data válida no formato H:i. Ex: 14:30

items   object  opcional  
groups_ids   integer[]  opcional  
notify_result_changes_in_items   boolean   

Ex: true

Ativar/desativar uma recorrência

requer autenticação

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

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',
    [
        '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'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

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

Exemplo de resposta (200):


{
    "id": 1,
    "name": "Manoela Ferraz Tamoio Sobrinho",
    "keep_original_groups_from_items": 1,
    "starts_at": "2026-10-02",
    "next_at": "2026-10-02",
    "last_at": "2026-10-02",
    "frequency": "weekly",
    "monthly_day_of_month": 1,
    "weekly_happens_on": [],
    "yearly_month": 1,
    "yearly_day": 1,
    "owner_id": 527,
    "customer_id": 287,
    "active": true,
    "every_x_days_number_of_days": 1,
    "specific_time": "14:30",
    "created_at": "2026-10-02T20:24:13.098025Z",
    "updated_at": "2026-10-02T20:24:13.098197Z",
    "notify_result_changes_in_items": 1
}

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

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"
);

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',
    [
        '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'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

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

Exemplo de resposta (200):


{
    "file_path": "exemplo",
    "download_name": "exemplo"
}

Request   

GET reports/ai-answers/{format?}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

format   string  opcional  

Ex: csv

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}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "one_result_per_row": true
};

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/orders/{format?}',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'one_result_per_row' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/reports/orders/{format?}'
payload = {
    "one_result_per_row": true
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Exemplo de resposta (200):


{
    "file_path": "exemplo",
    "download_name": "exemplo"
}

Request   

GET reports/orders/{format?}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros da URL

format   string  opcional  

Deve ser um destes:

  • xlsx
  • csv
  • json

Parâmetros do body

one_result_per_row   boolean   

Ex: true

Gera um relatório com os usuários de acordo com os filtros utilizados

requer autenticação

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

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

let body = {
    "filter": "active"
};

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/users/{format?}',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'filter' => 'active',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/reports/users/{format?}'
payload = {
    "filter": "active"
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Exemplo de resposta (200):


{
    "file_path": "exemplo",
    "download_name": "exemplo"
}

Request   

GET reports/users/{format?}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros da URL

format   string  opcional  

Deve ser um destes:

  • xlsx
  • csv
  • json

Parâmetros do body

filter   string  opcional  

Ex: active

Deve ser um destes:
  • active
  • deleted
  • all

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": "1999-01-08",
    "end_date": "2026-07-14"
};

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' => '1999-01-08',
            'end_date' => '2026-07-14',
        ],
    ]
);
$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": "1999-01-08",
    "end_date": "2026-07-14"
}
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 no formato Y-m. Ex: 1999-01-08

end_date   string   

Deve ser uma data válida no formato Y-m. Ex: 2026-07-14

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}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "begin_date": "2017-05-11",
    "end_date": "2018-09-06",
    "only_from_logged_user": true
};

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-status',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'begin_date' => '2017-05-11',
            'end_date' => '2018-09-06',
            'only_from_logged_user' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/reports/number-orders-per-status'
payload = {
    "begin_date": "2017-05-11",
    "end_date": "2018-09-06",
    "only_from_logged_user": true
}
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-status

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros do body

begin_date   string  opcional  

Deve ser uma data válida no formato Y-m-d. Ex: 2017-05-11

end_date   string  opcional  

Deve ser uma data válida no formato Y-m-d. Ex: 2018-09-06

only_from_logged_user   boolean  opcional  

Ex: true

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": "1991-12-17",
    "end_date": "1981-03-18"
};

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' => '1991-12-17',
            'end_date' => '1981-03-18',
        ],
    ]
);
$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": "1991-12-17",
    "end_date": "1981-03-18"
}
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 no formato Y-m-d. Ex: 1991-12-17

end_date   string   

Deve ser uma data válida no formato Y-m-d. Ex: 1981-03-18

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": "1990-09-20",
    "end_date": "2024-07-19"
};

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' => '1990-09-20',
            'end_date' => '2024-07-19',
        ],
    ]
);
$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": "1990-09-20",
    "end_date": "2024-07-19"
}
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 no formato Y-m-d. Ex: 1990-09-20

end_date   string   

Deve ser uma data válida no formato Y-m-d. Ex: 2024-07-19

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": "1990-07-14",
    "end_date": "2001-04-02"
};

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' => '1990-07-14',
            'end_date' => '2001-04-02',
        ],
    ]
);
$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": "1990-07-14",
    "end_date": "2001-04-02"
}
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 no formato Y-m. Ex: 1990-07-14

end_date   string   

Deve ser uma data válida no formato Y-m. Ex: 2001-04-02

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 Disponível apenas para clientes pós pagos (Com contrato)

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 campos personalizados de um serviço

requer autenticação

Retorna todos os campos personalizados específicos do serviço mais todos os campos globais (que servem para todos os serviços), ordenado pelo label

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

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/custom-order-fields',
    [
        '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/custom-order-fields'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

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

Request   

GET services/{service_id}/custom-order-fields

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

service_id   integer   

O ID do serviço. Ex: 10

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: 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, 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/0-9"
);

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/0-9',
    [
        '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/0-9'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

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

Exemplo de resposta (200):


{
    "id": 1,
    "code": "meu-codigo",
    "name": "Noa Lira Faro",
    "description": "Enim eum tempore nesciunt velit et qui.",
    "tags": [],
    "type": "Certificate",
    "ai_enabled": true,
    "spreadsheet_purchase_available": true,
    "instant_delivery": true,
    "short_name": "exemplo",
    "details_main_attribute": "exemplo",
    "auto_purchase_certificate_available_result_positive": true,
    "auto_purchase_certificate_available_result_negative": true,
    "verification_code_attributes": "exemplo",
    "created_at": "2026-10-02T20:24:13.262254Z",
    "updated_at": "2026-10-02T20:24:13.262450Z",
    "keywords": [],
    "free_emoluments": true,
    "show_new_tag": true
}

Request   

GET services/{id}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

id   integer   

O ID do serviço. Ex: 0-9

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: 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()

Exemplo de resposta (200):


{
    "id": 1,
    "code": "meu-codigo",
    "name": "Srta. Anita de Oliveira Salgado",
    "description": "Maiores fuga asperiores dignissimos rerum modi animi sit incidunt.",
    "tags": [],
    "type": "Certificate",
    "ai_enabled": true,
    "spreadsheet_purchase_available": true,
    "instant_delivery": true,
    "short_name": "exemplo",
    "details_main_attribute": "exemplo",
    "auto_purchase_certificate_available_result_positive": true,
    "auto_purchase_certificate_available_result_negative": true,
    "verification_code_attributes": "exemplo",
    "created_at": "2026-10-02T20:24:13.273736Z",
    "updated_at": "2026-10-02T20:24:13.273844Z",
    "keywords": [],
    "free_emoluments": true,
    "show_new_tag": true
}

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: 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/certidao-nascimento/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/certidao-nascimento/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/certidao-nascimento/federative-units'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

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

Request   

GET services/{serviceCode}/federative-units

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

serviceCode   string   

O código do serviço. Consulte em link Ex: certidao-nascimento

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/certidao-nascimento/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/certidao-nascimento/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/certidao-nascimento/federative-units/SP'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

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

Request   

GET services/{serviceCode}/federative-units/{federativeUnitAbbr}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

serviceCode   string   

O código do serviço. Consulte em link Ex: certidao-nascimento

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/certidao-nascimento/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/certidao-nascimento/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/certidao-nascimento/federative-units/SP/SAO_PAULO'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

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

Request   

GET services/{serviceCode}/federative-units/{federativeUnitAbbr}/{cityUrl}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

serviceCode   string   

O código do serviço. Consulte em link Ex: certidao-nascimento

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/certidao-nascimento/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/certidao-nascimento/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/certidao-nascimento/favorite'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

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

Request   

PUT services/{serviceCode}/favorite

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

serviceCode   string   

O código do serviço. Consulte em link Ex: certidao-nascimento

Remove um serviço dos favoritos

requer autenticação

Exemplo de requisição:
const url = new URL(
    "https://api2.cbrdoc.com.br/services/certidao-nascimento/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/certidao-nascimento/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/certidao-nascimento/favorite'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

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

Request   

DELETE services/{serviceCode}/favorite

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

serviceCode   string   

O código do serviço. Consulte em link Ex: certidao-nascimento

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/certidao-nascimento/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/certidao-nascimento/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/certidao-nascimento/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/{serviceCode}/available-formats

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros da URL

serviceCode   string   

O código do serviço. Consulte em link Ex: certidao-nascimento

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/certidao-nascimento/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/certidao-nascimento/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/certidao-nascimento/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()

Exemplo de resposta (200):


{
    "price": 1.5,
    "estimated_price_postpaid_customer": 1.5,
    "estimated_delivery_days": [],
    "all_items_included_in_plan": true
}

Request   

PUT services/{serviceCode}/prices-shipping-info

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros da URL

serviceCode   string   

O código do serviço. Consulte em link Ex: certidao-nascimento

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/certidao-nascimento/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/certidao-nascimento/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/certidao-nascimento/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/{serviceCode}/extras-prices-shipping-info

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros da URL

serviceCode   string   

O código do serviço. Consulte em link Ex: certidao-nascimento

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/certidao-nascimento/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/certidao-nascimento/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/certidao-nascimento/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/{serviceCode}/extra-informations/{info?}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros da URL

serviceCode   string   

O código do serviço. Consulte em link Ex: certidao-nascimento

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": 569
        }
    ]
};

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' => 569],
            ],
        ],
    ]
);
$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": 569
        }
    ]
}
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   

Must match an existing stored value. Ex: 569

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

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()

Exemplo de resposta (200):


{
    "user_id": 576,
    "requested_at": "2026-10-02T20:24:12.756166Z",
    "expiration_at": "2026-10-02T20:24:12.756311Z",
    "already_used": true
}

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/53bfd578011420508508d3877094a192228d90d1a44cca46e3aa4c1e7ff68c44"
);

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

let body = {
    "new_password": "Senha@123"
};

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/53bfd578011420508508d3877094a192228d90d1a44cca46e3aa4c1e7ff68c44',
    [
        'headers' => [
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'new_password' => 'Senha@123',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/password-reset/53bfd578011420508508d3877094a192228d90d1a44cca46e3aa4c1e7ff68c44'
payload = {
    "new_password": "Senha@123"
}
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: 53bfd578011420508508d3877094a192228d90d1a44cca46e3aa4c1e7ff68c44

Parâmetros do body

new_password   string   

Não pode ser superior a 255 caracteres. Ex: Senha@123

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": "nathalia69@example.org"
};

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' => 'nathalia69@example.org',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/password-reset'
payload = {
    "email": "nathalia69@example.org"
}
headers = {
  'Content-Type': 'application/json'
}

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

Exemplo de resposta (200):


{
    "user_id": 729,
    "requested_at": "2026-10-02T20:24:12.780422Z",
    "expiration_at": "2026-10-02T20:24:12.780568Z",
    "already_used": true
}

Request   

POST password-reset

Headers

Content-Type      

Ex: application/json

Parâmetros do body

email   string   

Ex: nathalia69@example.org

PUT user-groups/user/{user_id}

requer autenticação

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

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

let body = {
    "groups_ids": [
        496,
        722
    ]
};

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/user-groups/user/10',
    [
        'headers' => [
            'Authorization' => 'Bearer {SEU TOKEN}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'groups_ids' => [496, 722],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

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

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

Exemplo de resposta (200):


{
    "id": 1,
    "customer_id": 850,
    "name": "Sr. Tomás Saito Neto",
    "email": "bianca32@example.net",
    "email_verified_at": "2026-10-02T20:24:13.579467Z",
    "phone": "4344756671",
    "isolated_orders": true,
    "last_login_at": "2026-10-02T20:24:13.579698Z",
    "created_at": "2026-10-02T20:24:13.579781Z",
    "updated_at": "2026-10-02T20:24:13.579844Z",
    "free_order_summary_remaining": 1,
    "two_factor_confirmed_at": "2026-10-02T20:24:13.579924Z"
}

Request   

PUT user-groups/user/{user_id}

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

groups_ids   integer[]  opcional  

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 = {
    "email": "irene.carvalho@example.net",
    "name": "Ohana da Cruz Neto",
    "password": "Senha@123",
    "permissions": [
        1
    ],
    "phone": "1320487154"
};

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' => [
            'email' => 'irene.carvalho@example.net',
            'name' => 'Ohana da Cruz Neto',
            'password' => 'Senha@123',
            'permissions' => [1],
            'phone' => '1320487154',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api2.cbrdoc.com.br/users'
payload = {
    "email": "irene.carvalho@example.net",
    "name": "Ohana da Cruz Neto",
    "password": "Senha@123",
    "permissions": [
        1
    ],
    "phone": "1320487154"
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Exemplo de resposta (200):


{
    "id": 1,
    "customer_id": 242,
    "name": "Srta. Taís Prado Saraiva",
    "email": "cordeiro.viviane@example.net",
    "email_verified_at": "2026-10-02T20:24:13.597894Z",
    "phone": "63981512059",
    "isolated_orders": true,
    "last_login_at": "2026-10-02T20:24:13.598134Z",
    "created_at": "2026-10-02T20:24:13.598222Z",
    "updated_at": "2026-10-02T20:24:13.598281Z",
    "free_order_summary_remaining": 1,
    "two_factor_confirmed_at": "2026-10-02T20:24:13.598355Z"
}

Request   

POST users

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Content-Type      

Ex: application/json

Parâmetros do body

email   string   

Deve ser um endereço de e-mail válido. Não pode ser superior a 200 caracteres. Ex: irene.carvalho@example.net

name   string   

Não pode ser superior a 60 caracteres. Ex: Ohana da Cruz Neto

password   string   

Não pode ser superior a 255 caracteres. Ex: Senha@123

permissions   integer[]   

Deve corresponder a um valor já cadastrado.

phone   string  opcional  

Não pode ser superior a 15 caracteres. Ex: 1320487154

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, groups, groups_count, groupsExists, 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: customer.total_ai_tokens_remaining, customer.ai_tokens_above_limit

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, groups, groups_count, groupsExists, 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: customer.total_ai_tokens_remaining, customer.ai_tokens_above_limit

Visualizar a quantidade de usuários da conta com a permissão de gerenciar usuários e dados da empresa

requer autenticação

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

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/manage-data-permission-users-count',
    [
        '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/manage-data-permission-users-count'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

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

Request   

GET users/manage-data-permission-users-count

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Visualizar um usuário

requer autenticação

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

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/0-9',
    [
        '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/0-9'
headers = {
  'Authorization': 'Bearer {SEU TOKEN}'
}

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

Exemplo de resposta (200):


{
    "id": 1,
    "customer_id": 745,
    "name": "Tábata Daiane Gusmão",
    "email": "queiros.thalia@example.net",
    "email_verified_at": "2026-10-02T20:24:13.643806Z",
    "phone": "97904147486",
    "isolated_orders": true,
    "last_login_at": "2026-10-02T20:24:13.644125Z",
    "created_at": "2026-10-02T20:24:13.644216Z",
    "updated_at": "2026-10-02T20:24:13.644279Z",
    "free_order_summary_remaining": 1,
    "two_factor_confirmed_at": "2026-10-02T20:24:13.644364Z"
}

Request   

GET users/{id}

Headers

Authorization      

Ex: Bearer {SEU TOKEN}

Parâmetros da URL

id   integer   

O ID do usuário. Ex: 0-9

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, groups, groups_count, groupsExists, 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: customer.total_ai_tokens_remaining, customer.ai_tokens_above_limit

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, groups, groups_count, groupsExists, 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: customer.total_ai_tokens_remaining, customer.ai_tokens_above_limit

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": [
        1
    ]
};

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' => [1],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

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

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

Exemplo de resposta (200):


{
    "id": 1,
    "customer_id": 32,
    "name": "Sr. André Amaral Caldeira",
    "email": "veronica.molina@example.net",
    "email_verified_at": "2026-10-02T20:24:13.673289Z",
    "phone": "32943986365",
    "isolated_orders": true,
    "last_login_at": "2026-10-02T20:24:13.673518Z",
    "created_at": "2026-10-02T20:24:13.673573Z",
    "updated_at": "2026-10-02T20:24:13.673610Z",
    "free_order_summary_remaining": 1,
    "two_factor_confirmed_at": "2026-10-02T20:24:13.673657Z"
}

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[]   

Deve corresponder a um valor já cadastrado.

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": [
        "database",
        "mail"
    ],
    "placed_purchase_notification_via": [
        "database",
        "mail"
    ],
    "finished_order_notification_via": [
        "database",
        "mail"
    ],
    "pending_action_notification_via": [
        "database",
        "mail"
    ],
    "refunded_order_notification_via": [
        "database",
        "mail"
    ],
    "spreadsheet_placed_purchase_notification_via": [],
    "finished_purchase_notification_via": [
        "database",
        "mail"
    ],
    "certificate_expired_notification_via": [
        "database",
        "mail"
    ],
    "system_information_notification_via": [
        "database",
        "mail"
    ],
    "system_unavailable_notification_via": [
        "database",
        "mail"
    ],
    "summary_extracted_notification_via": [
        "database",
        "mail"
    ],
    "order_challenge_notification_via": [
        "database",
        "mail"
    ],
    "failed_purchase_notification_via": [
        "database",
        "mail"
    ],
    "order_finished_positive_result_via": [
        "database",
        "mail"
    ],
    "canceled_order_notification_via": [
        "database",
        "mail"
    ],
    "spreadsheet_placed_purchase_notification": [
        "database",
        "mail"
    ]
};

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' => ['database', 'mail'],
            'placed_purchase_notification_via' => ['database', 'mail'],
            'finished_order_notification_via' => ['database', 'mail'],
            'pending_action_notification_via' => ['database', 'mail'],
            'refunded_order_notification_via' => ['database', 'mail'],
            'spreadsheet_placed_purchase_notification_via' => [],
            'finished_purchase_notification_via' => ['database', 'mail'],
            'certificate_expired_notification_via' => ['database', 'mail'],
            'system_information_notification_via' => ['database', 'mail'],
            'system_unavailable_notification_via' => ['database', 'mail'],
            'summary_extracted_notification_via' => ['database', 'mail'],
            'order_challenge_notification_via' => ['database', 'mail'],
            'failed_purchase_notification_via' => ['database', 'mail'],
            'order_finished_positive_result_via' => ['database', 'mail'],
            'canceled_order_notification_via' => ['database', 'mail'],
            'spreadsheet_placed_purchase_notification' => ['database', 'mail'],
        ],
    ]
);
$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": [
        "database",
        "mail"
    ],
    "placed_purchase_notification_via": [
        "database",
        "mail"
    ],
    "finished_order_notification_via": [
        "database",
        "mail"
    ],
    "pending_action_notification_via": [
        "database",
        "mail"
    ],
    "refunded_order_notification_via": [
        "database",
        "mail"
    ],
    "spreadsheet_placed_purchase_notification_via": [],
    "finished_purchase_notification_via": [
        "database",
        "mail"
    ],
    "certificate_expired_notification_via": [
        "database",
        "mail"
    ],
    "system_information_notification_via": [
        "database",
        "mail"
    ],
    "system_unavailable_notification_via": [
        "database",
        "mail"
    ],
    "summary_extracted_notification_via": [
        "database",
        "mail"
    ],
    "order_challenge_notification_via": [
        "database",
        "mail"
    ],
    "failed_purchase_notification_via": [
        "database",
        "mail"
    ],
    "order_finished_positive_result_via": [
        "database",
        "mail"
    ],
    "canceled_order_notification_via": [
        "database",
        "mail"
    ],
    "spreadsheet_placed_purchase_notification": [
        "database",
        "mail"
    ]
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Exemplo de resposta (200):


{
    "id": 1,
    "customer_id": 460,
    "name": "Dr. Vinícius Alves Neto",
    "email": "benez.heloisa@example.com",
    "email_verified_at": "2026-10-02T20:24:13.704781Z",
    "phone": "4747172467",
    "isolated_orders": true,
    "last_login_at": "2026-10-02T20:24:13.705078Z",
    "created_at": "2026-10-02T20:24:13.705184Z",
    "updated_at": "2026-10-02T20:24:13.705262Z",
    "free_order_summary_remaining": 1,
    "two_factor_confirmed_at": "2026-10-02T20:24:13.705350Z"
}

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
finished_order_notification_via   string[]   
Deve ser um destes:
  • database
  • mail
pending_action_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  
finished_purchase_notification_via   string[]   
Deve ser um destes:
  • database
  • mail
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
failed_purchase_notification_via   string[]   
Deve ser um destes:
  • database
  • mail
order_finished_positive_result_via   string[]   
Deve ser um destes:
  • database
  • mail
canceled_order_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": "Senha@123",
    "new_password": "Senha@123"
};

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' => 'Senha@123',
            'new_password' => 'Senha@123',
        ],
    ]
);
$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": "Senha@123",
    "new_password": "Senha@123"
}
headers = {
  'Authorization': 'Bearer {SEU TOKEN}',
  'Content-Type': 'application/json'
}

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

Exemplo de resposta (200):


{
    "id": 1,
    "customer_id": 563,
    "name": "Dr. Iasmin Alice Rosa Filho",
    "email": "iferminiano@example.org",
    "email_verified_at": "2026-10-02T20:24:13.728346Z",
    "phone": "8333031479",
    "isolated_orders": true,
    "last_login_at": "2026-10-02T20:24:13.728553Z",
    "created_at": "2026-10-02T20:24:13.728620Z",
    "updated_at": "2026-10-02T20:24:13.728681Z",
    "free_order_summary_remaining": 1,
    "two_factor_confirmed_at": "2026-10-02T20:24:13.728762Z"
}

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. Ex: Senha@123

new_password   string   

Não pode ser superior a 255 caracteres. Ex: Senha@123

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.

Antecedentes Criminais - Federal

POST /services/{serviceId}/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. Ex: 18226879779

nome   string   

Não pode ser superior a 255 caracteres. Ex: Srta. Anita da Cruz

nascimento   string   

Deve ser uma data válida no formato Y-m-d. Deve ser uma data anterior ou igual a hoje. Ex: 2014-11-24

mae   string   

Não pode ser superior a 255 caracteres. Ex: Daiane Andressa Fernandes Neto

Ata Notarial

POST /services/{serviceId}/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}/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   

Ex: diligencia-presencial-do-tabeliao

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  

Este campo é obrigatório quando tipo_servico for diligencia-presencial-do-tabeliao. Não pode ser superior a 500 caracteres. Ex: exemplo

mensagem   string   

Não pode ser superior a 500 caracteres. Ex: exemplo

tipo_servico   string   

Ex: diligencia-presencial-do-tabeliao

Deve ser um destes:
  • diligencia-presencial-do-tabeliao
  • ja-possuo-as-evidencias
arquivos   string[]   
observacoes   string  opcional  

Não pode ser superior a 500 caracteres. Ex: exemplo

Baixa de Protesto

POST /services/{serviceId}/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}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 38806418629

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 54192926000155

nome   string   

Não pode ser superior a 255 caracteres. Ex: Jácomo Alves Soares

numero_titulo   string   

Ex: exemplo

observacoes   string  opcional  

Não pode ser superior a 260 caracteres. Ex: exemplo

arquivos   string[]   

Cadastro de Contribuintes de ICMS - CADESP

POST /services/{serviceId}/available-formats

url_uf   string   

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

POST /services/{serviceId}/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   

Deve ser 14 caracteres. Ex: 40626961000120

Cadastro Informativo Estadual - CADIN Estadual

POST /services/{serviceId}/available-formats

url_uf   string   

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

POST /services/{serviceId}/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. Ex: exemplo

CAFIR - Cadastro de Imóveis Rurais

POST /services/{serviceId}/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. Ex: exemplo

Capa de IPTU – Prefeitura

POST /services/{serviceId}/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}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 86271813143

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 93046134000124

inscricao_imovel   string   

Não pode ser superior a 255 caracteres. Ex: exemplo

Carnê de IPTU - Prefeitura

POST /services/{serviceId}/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}/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. Ex: exemplo

Certidão Ambiental Estadual

POST /services/{serviceId}/available-formats

url_uf   string   

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

POST /services/{serviceId}/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}/extra-informations

tipo_pessoa   string   

Ex: fisica

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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 87070104600

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 91664628000147

nome   string   

Não pode ser superior a 255 caracteres. Ex: Dr. Dener Estrada Sobrinho

url_uf   string   

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

rg   string  opcional  

Ex: 090115210

rg_data_expedicao   string  opcional  

Deve ser uma data válida no formato Y-m-d. Ex: 2015-03-22

rg_uf_expedicao   string  opcional  

Ex: AC

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 no formato Y-m-d. Ex: 1981-07-28

motivo_solicitacao   string  opcional  

Ex: exemplo

arquivos   string[]   

Um array com o caminho dos arquivos enviados no endpoint de upload: link

Certidão Ambiental Municipal – Prefeitura

POST /services/{serviceId}/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}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 72995265226

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 80186093000120

endereco   string   

Não pode ser superior a 255 caracteres. Ex: R. Gilberto, 8217. F

arquivos   string[]   

Um array com o caminho dos arquivos enviados no endpoint de upload: link

Certidão Confrontantes de Imóvel

POST /services/{serviceId}/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}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 74156512789

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 17846726000142

nome   string   

Não pode ser superior a 255 caracteres. Ex: Inácio Luan da Cruz Filho

inscricao_imovel   string   

Não pode ser superior a 255 caracteres. Ex: exemplo

matricula   string   

Não pode ser superior a 255 caracteres. Ex: exemplo

endereco   string   

Não pode ser superior a 255 caracteres. Ex: Avenida Allan Mascarenhas, 5334

arquivo_matricula_atualizada   string   

Ex: exemplo

arquivo_espelho_iptu_atual   string   

Ex: exemplo

Certidão de Alienação Fiduciária (RI)

POST /services/{serviceId}/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}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 25762895254

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 05036535000136

nome   string   

Não pode ser superior a 255 caracteres. Ex: Agatha Cláudia Saraiva Filho

safra   string   

Não pode ser superior a 255 caracteres. Ex: exemplo

commoditie   string   

Não pode ser superior a 255 caracteres. Ex: exemplo

Certidão de Alienação Fiduciária (RTD)

POST /services/{serviceId}/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}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 47377740060

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 75817556000174

nome   string   

Não pode ser superior a 255 caracteres. Ex: Srta. Karina Mila Sepúlveda Jr.

tipo   string   

Ex: safra

Deve ser um destes:
  • safra
  • outro
safra   string  opcional  

Este campo é obrigatório quando tipo for safra. Não pode ser superior a 255 caracteres. Ex: exemplo

commoditie   string  opcional  

Este campo é obrigatório quando tipo for safra. Não pode ser superior a 255 caracteres. Ex: exemplo

onus   string  opcional  

Este campo é obrigatório quando tipo for outro. Não pode ser superior a 255 caracteres. Ex: exemplo

numero_registro   string  opcional  

Não pode ser superior a 75 caracteres. Ex: exemplo

periodo   string  opcional  

Não pode ser superior a 75 caracteres. Ex: exemplo

Certidão de Antecedentes Criminais Estadual

POST /services/{serviceId}/available-formats

url_uf   string   

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

POST /services/{serviceId}/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. Ex: 69159504510

nome   string   

Não pode ser superior a 255 caracteres. Ex: Sra. Naomi Carvalho Sobrinho

nascimento   string   

Deve ser uma data válida no formato Y-m-d. Deve ser uma data anterior ou igual a hoje. Ex: 2017-01-08

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. Ex: Thalita Cecília Alves Neto

pai   string   

Não pode ser superior a 255 caracteres. Ex: Emiliano Marinho Jr.

rg   string   

Não pode ser superior a 15 caracteres. Ex: 517006529

rg_data_expedicao   string  opcional  

Este campo é obrigatório quando url_uf for SP. Deve ser uma data válida no formato Y-m-d. Ex: 1998-08-10

genero   string  opcional  

Este campo é obrigatório quando url_uf for SP. Ex: masculino

Deve ser um destes:
  • masculino
  • feminino

Certidão de Auto de Multa (UNICAI/UNAI)

POST /services/{serviceId}/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}/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. Ex: exemplo

Certidão de Casamento

POST /services/{serviceId}/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}/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}/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. Ex: exemplo

pagina   string  opcional  

Não pode ser superior a 3 caracteres. Ex: exemplo

termo   string  opcional  

Não pode ser superior a 7 caracteres. Ex: exemplo

conjuge1   string   

Não pode ser superior a 255 caracteres. Ex: exemplo

conjuge2   string   

Não pode ser superior a 255 caracteres. Ex: exemplo

casamento   string   

Deve ser uma data válida no formato Y-m-d. Deve ser uma data anterior ou igual a hoje. Ex: 1998-12-31

pedido_origem_id   integer  opcional  

Deve corresponder a um valor já cadastrado. Ex: 936

Certidão de Crime Eleitoral

POST /services/{serviceId}/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. Ex: Sra. Thalissa Gabrielle Domingues Sobrinho

pai   string  opcional  

Não pode ser superior a 255 caracteres. Ex: Emílio Paz Filho

mae   string  opcional  

Não pode ser superior a 255 caracteres. Ex: Suelen Lavínia Ávila Neto

nascimento   string   

Deve ser uma data válida no formato Y-m-d. Deve ser uma data anterior ou igual a hoje. Ex: 1994-08-02

documento   string   

Deve ter pelo menos 11 caracteres. Não pode ser superior a 12 caracteres. Ex: exemplo

Certidão de Dados Cadastrais do Imóvel – Prefeitura

POST /services/{serviceId}/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}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 72140604695

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 32014986000145

inscricao_imovel   string   

Não pode ser superior a 255 caracteres. Ex: exemplo

Certidão de Desapropriação Estadual

POST /services/{serviceId}/available-formats

url_uf   string   

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

POST /services/{serviceId}/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_imovel   string   

Não pode ser superior a 255 caracteres. Ex: exemplo

matricula   string   

Não pode ser superior a 255 caracteres. Ex: exemplo

arquivo   string  opcional  

Ex: exemplo

Certidão de Desapropriação Municipal

POST /services/{serviceId}/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}/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. Ex: exemplo

arquivo   string  opcional  

Ex: exemplo

Certidão de Distribuição de Feitos - TST

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 51283806533

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 87108503000163

nome   string   

Não pode ser superior a 255 caracteres. Ex: Srta. Talita Carmona Jr.

Certidão de Escritura

POST /services/{serviceId}/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}/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   

Ex: true

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 33831250170

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 55337399000192

nome   string   

Não pode ser superior a 255 caracteres. Ex: Valéria Mendonça Velasques

pedido_origem_id   integer  opcional  

Deve corresponder a um valor já cadastrado. Ex: 897

livro   string  opcional  

Este campo é obrigatório quando nao_sei_livro_pagina for false. Ex: exemplo

pagina   string  opcional  

Este campo é obrigatório quando nao_sei_livro_pagina for false. Ex: exemplo

nao_sei_livro_pagina   boolean   

Ex: true

data_ato   string  opcional  

Deve ser uma data válida no formato Y-m-d. Ex: 1992-04-30

tipo   string   

Ex: exemplo

arquivos   string[]   

Certidão de Imóvel

POST /services/{serviceId}/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   

Ex: matricula

Deve ser um destes:
  • matricula
  • transcricao
  • docarquivado
  • inteiroteor
  • livro3auxiliar
  • livro3garantias
  • onus
  • quesitos
  • vintenaria
  • propriedade
  • condominio
  • pactoantenupcial
  • cadeia_dominial

POST /services/{serviceId}/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   

Ex: matricula

Deve ser um destes:
  • matricula
  • transcricao
  • docarquivado
  • inteiroteor
  • livro3auxiliar
  • livro3garantias
  • onus
  • quesitos
  • vintenaria
  • propriedade
  • condominio
  • pactoantenupcial
  • cadeia_dominial

POST /services/{serviceId}/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   

Ex: matricula

Deve ser um destes:
  • matricula
  • transcricao
  • docarquivado
  • inteiroteor
  • livro3auxiliar
  • livro3garantias
  • onus
  • quesitos
  • vintenaria
  • propriedade
  • condominio
  • pactoantenupcial
  • cadeia_dominial

POST /services/{serviceId}/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   

Ex: matricula

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  

Deve corresponder a um valor já cadastrado. Ex: 650

tipo   string   

Ex: matricula

Deve ser um destes:
  • matricula
  • transcricao
  • docarquivado
  • inteiroteor
  • livro3auxiliar
  • livro3garantias
  • onus
  • quesitos
  • vintenaria
  • propriedade
  • condominio
  • pactoantenupcial
  • cadeia_dominial
buscar_por   string   

Ex: exemplo

matricula   string  opcional  

Não pode ser superior a 255 caracteres. Ex: exemplo

transcricao   string  opcional  

Ex: exemplo

endereco   string  opcional  

Ex: Rua Santiago, 96

cep   string  opcional  

Deve ser 8 caracteres. Ex: 47697372

condominio   string  opcional  

Ex: exemplo

registro_livro3   string  opcional  

Ex: exemplo

ato   string  opcional  

Ex: exemplo

data_emissao   string  opcional  

Deve ser uma data válida no formato Y-m-d. Ex: 2001-04-29

livro   string  opcional  

Ex: exemplo

nome   string  opcional  

Ex: Sra. Ellen Emanuelly Santana

documento   string  opcional  

Ex: exemplo

protocolo   string  opcional  

Ex: exemplo

conjuge1_nome   string  opcional  

Ex: exemplo

conjuge2_nome   string  opcional  

Ex: exemplo

conjuge1_cpf   string  opcional  

Ex: 90010023585

conjuge2_cpf   string  opcional  

Ex: 92425392440

casamento   string  opcional  

Deve ser uma data válida no formato Y-m-d. Ex: 1989-03-07

numero_registro   string  opcional  

Ex: exemplo

observacoes   string  opcional  

Não pode ser superior a 500 caracteres. Ex: exemplo

dominial_ano_limite   integer  opcional  

Deve ser pelo menos 1800. Não pode ser superior a 2099. Ex: 1950

Certidão de Interdição

POST /services/{serviceId}/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}/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}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 28243358315

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 63716116000141

nome   string   

Não pode ser superior a 255 caracteres. Ex: Rafaela Ávila Franco Filho

mae   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Não pode ser superior a 255 caracteres. Ex: Tainara Fonseca

pai   string  opcional  

Não pode ser superior a 255 caracteres. Ex: Sr. Mário Delgado Filho

nascimento   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser uma data válida no formato Y-m-d. Deve ser uma data anterior ou igual a hoje. Ex: 2014-03-09

rg   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Ex: 218289499

uf_nascimento   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Ex: AC

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  

Este campo é obrigatório quando tipo_pessoa for fisica. Ex: exemplo

ano_aproximado_ato   integer  opcional  

Deve ser entre 1900 e 2026. Ex: 1963

Certidão de Nascimento

POST /services/{serviceId}/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}/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}/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. Ex: exemplo

pagina   string  opcional  

Não pode ser superior a 3 caracteres. Ex: exemplo

termo   string  opcional  

Não pode ser superior a 7 caracteres. Ex: exemplo

nome   string   

Não pode ser superior a 255 caracteres. Ex: Sra. Aparecida Batista

mae   string   

Não pode ser superior a 255 caracteres. Ex: Sra. Fátima Duarte

pai   string  opcional  

Não pode ser superior a 255 caracteres. Ex: Dr. Ivan Azevedo Guerra Filho

nascimento   string   

Deve ser uma data válida no formato Y-m-d. Deve ser uma data anterior ou igual a hoje. Ex: 2015-10-06

pedido_origem_id   integer  opcional  

Deve corresponder a um valor já cadastrado. Ex: 925

Certidão de Óbito

POST /services/{serviceId}/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}/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}/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. Ex: exemplo

pagina   string  opcional  

Não pode ser superior a 3 caracteres. Ex: exemplo

termo   string  opcional  

Não pode ser superior a 7 caracteres. Ex: exemplo

nome   string   

Não pode ser superior a 255 caracteres. Ex: Wilson Vila Neto

mae   string   

Não pode ser superior a 255 caracteres. Ex: Srta. Estela Godói Colaço Sobrinho

pai   string  opcional  

Não pode ser superior a 255 caracteres. Ex: Fabrício Campos Neto

obito   string   

Deve ser uma data válida no formato Y-m-d. Deve ser uma data anterior ou igual a hoje. Ex: 2020-09-07

pedido_origem_id   integer  opcional  

Deve corresponder a um valor já cadastrado. Ex: 152

Certidão de Objeto e Pé

POST /services/{serviceId}/available-formats

url_uf   string   

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

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 03032640393

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 69698571000148

nome   string   

Não pode ser superior a 255 caracteres. Ex: Sra. Bárbara Ferraz Jr.

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. Ex: exemplo

Certidão de Penhor de Safra

POST /services/{serviceId}/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}/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}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 92642069303

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 55905877000113

nome   string   

Não pode ser superior a 255 caracteres. Ex: Srta. Alessandra Stephany Uchoa Sobrinho

tipo_safra   string   

Não pode ser superior a 255 caracteres. Ex: exemplo

safra   string   

Não pode ser superior a 255 caracteres. Ex: exemplo

registro   string  opcional  

Não pode ser superior a 255 caracteres. Ex: exemplo

nome_propriedade   string  opcional  

Não pode ser superior a 255 caracteres. Ex: exemplo

Certidão de Prévia de Matrícula – Matrícula Online

POST /services/{serviceId}/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}/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  

Deve corresponder a um valor já cadastrado. Ex: 800

matricula   string   

Não pode ser superior a 255 caracteres. Ex: exemplo

observacoes   string  opcional  

Não pode ser superior a 500 caracteres. Ex: exemplo

Certidão de Processo Administrativo Sancionador

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 37005453395

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 15230512000111

nome   string   

Não pode ser superior a 255 caracteres. Ex: Srta. Louise Fontes Corona

Certidão de Procuração

POST /services/{serviceId}/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}/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   

Ex: true

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 88611559100

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 21776303000170

nome   string   

Não pode ser superior a 255 caracteres. Ex: Caio Breno Deverso

pedido_origem_id   integer  opcional  

Deve corresponder a um valor já cadastrado. Ex: 717

livro   string  opcional  

Este campo é obrigatório quando nao_sei_livro_pagina for false. Ex: exemplo

pagina   string  opcional  

Este campo é obrigatório quando nao_sei_livro_pagina for false. Ex: exemplo

nao_sei_livro_pagina   boolean   

Ex: true

data_ato   string  opcional  

Deve ser uma data válida no formato Y-m-d. Ex: 1993-05-16

Certidão de Propriedade de Aeronave

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 43010468792

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 51598784000132

nome   string   

Não pode ser superior a 255 caracteres. Ex: Dr. Kauan Paz Mendonça

matricula   string   

Não pode ser superior a 255 caracteres. Ex: exemplo

Certidão de Protesto

POST /services/{serviceId}/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   

Ex: 1

POST /services/{serviceId}/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   

Ex: 1

POST /services/{serviceId}/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}/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[]   

Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

tipo_pessoa   string   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 30037757741

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 73629796000110

nome   string   

Não pode ser superior a 255 caracteres. Ex: Heitor Brito Neto

pedido_origem_id   integer  opcional  

Deve corresponder a um valor já cadastrado. Ex: 96

tempo_pesquisa   integer   

Ex: 1

rg   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Ex: 656608560

cep   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 8 caracteres. Ex: 12171179

Certidão de Registro Sindical

POST /services/{serviceId}/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. Ex: 24253440000119

Certidão de Regularidade na Contratação de Aprendizes

POST /services/{serviceId}/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. Ex: 61831657000195

Certidão de Taxa de Incêndio

POST /services/{serviceId}/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}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 41243582537

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 56052929000119

nome   string   

Não pode ser superior a 255 caracteres. Ex: Wesley Escobar Amaral

inscricao_imovel   string   

Não pode ser superior a 255 caracteres. Ex: exemplo

matricula   string   

Não pode ser superior a 255 caracteres. Ex: exemplo

endereco   string   

Não pode ser superior a 255 caracteres. Ex: Avenida Renato de Souza, 103

area_metros_quadrados   number   

Ex: 1.5

Certidão de Testamento (Positiva ou Negativa) – CENSEC

POST /services/{serviceId}/available-formats

tipo_livro   string   

Ex: exemplo

POST /services/{serviceId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_livro   string   

Ex: exemplo

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. Ex: Dr. Otávio Delgado Martines

nascimento   string   

Deve ser uma data válida no formato Y-m-d. Deve ser uma data anterior ou igual a hoje. Ex: 1991-06-29

cpf   string   

Deve ser 11 caracteres. Ex: 55544711968

tipo_documento   string   

Ex: exemplo

cnh_passaporte_rg_rne   string   

Ex: exemplo

orgao_emissor   string   

Ex: exemplo

obito   string   

Deve ser uma data válida no formato Y-m-d. Deve ser uma data anterior ou igual a hoje. Ex: 1987-08-16

matricula   string  opcional  

Não pode ser superior a 255 caracteres. Ex: exemplo

url_uf   string   

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

tipo_livro   string   

Ex: exemplo

livro   string  opcional  

Ex: exemplo

pagina   string  opcional  

Ex: exemplo

mae   string   

Não pode ser superior a 255 caracteres. Ex: Manuela Alícia Barreto

pai   string  opcional  

Não pode ser superior a 255 caracteres. Ex: Dr. Vicente Bruno Flores Jr.

arquivo_certidao_obito   string   

Ex: exemplo

Certidão de Títulos e Documentos e de Pessoas Jurídicas

POST /services/{serviceId}/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}/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   

Ex: exemplo

tipo_certidao   string   

Ex: exemplo

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 27919053838

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 08780862000196

nome   string   

Não pode ser superior a 255 caracteres. Ex: Dr. Alan Marques Fonseca

pedido_origem_id   integer  opcional  

Deve corresponder a um valor já cadastrado. Ex: 112

tipo_documento   string   

Ex: exemplo

tipo_certidao   string   

Ex: exemplo

numero_registro   string  opcional  

Ex: exemplo

data_registro   string  opcional  

Deve ser uma data válida no formato Y-m-d. Ex: 2011-03-27

quesito   string  opcional  

Ex: exemplo

Certidão de Tombamento - IPHAN

POST /services/{serviceId}/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}/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. Ex: exemplo

matricula   string   

Não pode ser superior a 255 caracteres. Ex: exemplo

arquivo   string  opcional  

Ex: exemplo

Certidão de Tombamento Municipal

POST /services/{serviceId}/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}/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. Ex: exemplo

matricula   string   

Não pode ser superior a 255 caracteres. Ex: exemplo

arquivo   string  opcional  

Ex: exemplo

Certidão de Uso e Ocupação do Solo

POST /services/{serviceId}/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}/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. Ex: exemplo

arquivo   string  opcional  

Ex: exemplo

Certidão de Valor Venal – Prefeitura

POST /services/{serviceId}/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}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 65470317722

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 34731837000122

inscricao_imovel   string   

Não pode ser superior a 255 caracteres. Ex: exemplo

observacoes   string  opcional  

Não pode ser superior a 500 caracteres. Ex: exemplo

arquivos   string[]   

Um array com o caminho dos arquivos enviados no endpoint de upload: link

Certidão do INSS - Previdência Social

POST /services/{serviceId}/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. Ex: 88482734000103

cei   string  opcional  

Não pode ser superior a 13 caracteres. Ex: exemplo

Certidão do SPU

POST /services/{serviceId}/available-formats

tipo   string   

Ex: exemplo

POST /services/{serviceId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo   string   

Ex: exemplo

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo   string   

Ex: exemplo

numero_rip   string  opcional  

Este campo é obrigatório quando nenhum de cpf, cnpj, and nome estiverem presentes. Ex: exemplo

cpf   string  opcional  

Este campo é obrigatório quando nenhum de numero_rip, cnpj, and nome estiverem presentes. Ex: 42937145612

cnpj   string  opcional  

Este campo é obrigatório quando nenhum de numero_rip, cpf, and nome estiverem presentes. Ex: 52455338000131

nome   string  opcional  

Este campo é obrigatório quando nenhum de numero_rip, cpf, and cnpj estiverem presentes. Ex: Dr. Mel Zaragoça Jr.

Certidão Negativa Correcional (CGU-PJ, CEIS, CNEP e CEPIM)

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 24508997660

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 29761305000106

Certidão para Entidades Supervisionadas

POST /services/{serviceId}/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. Ex: 30357928000199

Certificado de Cadastro do Imóvel Rural - CCIR

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
natureza_juridica   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Ex: exemplo

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
natureza_juridica   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Ex: exemplo

POST /services/{serviceId}/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   

Ex: fisica

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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 48841195177

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 97132591000192

codigo_imovel   string   

Deve ser 13 caracteres. Ex: exemplo

natureza_juridica   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Ex: exemplo

Certificado de Regularidade do FGTS - CRF

POST /services/{serviceId}/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  opcional  

Este campo é obrigatório quando cpf for not present. Deve ser 14 caracteres. Deve ser informado o cnpj ou o cpf, nunca os dois. Ex: 71600667000173

cpf   string  opcional  

Este campo é obrigatório quando cnpj for not present. Deve ser 11 caracteres. Deve ser informado o cnpj ou o cpf, nunca os dois. Ex: 39662580050

cei   string  opcional  

Não pode ser superior a 13 caracteres. Ex: exemplo

CGU - Certidão Negativa Correcional (EPAD e CGU-PAD)

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 81962088987

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 34212788000111

CNJ - Improbidade Administrativa e Inelegibilidade

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 00682482617

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 79915529000195

CRDA - Certidão Negativa de Débitos Tributários – PGE

POST /services/{serviceId}/available-formats

url_uf   string   

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

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 32703532431

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 54306799000178

nome   string   

Não pode ser superior a 255 caracteres. Ex: Matheus Vicente Soares

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. Ex: exemplo

solicitante_rg   string  opcional  

Não pode ser superior a 20 caracteres. Ex: exemplo

solicitante_orgao_expedidor_rg   string  opcional  

Não pode ser superior a 50 caracteres. Ex: exemplo

solicitante_data_emissao_rg   string  opcional  

Deve ser uma data válida no formato Y-m-d. Ex: 2003-04-02

endereco_logradouro   string  opcional  

Não pode ser superior a 120 caracteres. Ex: exemplo

endereco_numero   string  opcional  

Não pode ser superior a 8 caracteres. Ex: exemplo

endereco_complemento   string  opcional  

Não pode ser superior a 60 caracteres. Ex: exemplo

endereco_cep   string  opcional  

Deve ser 8 caracteres. Ex: exemplo

endereco_bairro   string  opcional  

Não pode ser superior a 80 caracteres. Ex: exemplo

endereco_cidade   string  opcional  

Não pode ser superior a 140 caracteres. Ex: exemplo

endereco_uf   string  opcional  

Ex: AC

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

Extrato de Débitos Estadual

POST /services/{serviceId}/available-formats

url_uf   string   

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

POST /services/{serviceId}/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. Ex: exemplo

Extrato de Débitos Municipal – Prefeitura

POST /services/{serviceId}/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}/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

buscar_por   string   

Ex: cpf

Deve ser um destes:
  • cpf
  • cnpj
  • inscricao-imovel
cpf   string  opcional  

Este campo é obrigatório quando buscar_por for cpf. Deve ser 11 caracteres. Ex: 74480843213

cnpj   string  opcional  

Este campo é obrigatório quando buscar_por for cnpj. Deve ser 14 caracteres. Ex: 24428843000151

inscricao_imovel   string  opcional  

Este campo é obrigatório quando buscar_por for inscricao-imovel. Não pode ser superior a 255 caracteres. Ex: exemplo

IBAMA - Certidão de Embargos

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 39584191942

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 12417359000148

IBAMA - Certidão Negativa de Débitos

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 98404727716

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 74248583000100

nome   string   

Não pode ser superior a 255 caracteres. Ex: Dr. Evandro Pontes Padrão Filho

Junta Comercial - Certidão da Empresa

POST /services/{serviceId}/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   

Ex: exemplo

POST /services/{serviceId}/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   

Ex: exemplo

tipo_pessoa   string   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cnpj   string  opcional  

Deve ser 14 caracteres. Ex: 03060448000199

cpf   string  opcional  

Deve ser 11 caracteres. Ex: 62834628637

razao_social   string  opcional  

Ex: Maia e Marin

numero_ato   string  opcional  

Ex: exemplo

pedido_origem_id   integer  opcional  

Deve corresponder a um valor já cadastrado. Ex: 93

tipo_especificacao   string  opcional  

Este campo é obrigatório quando tipo for especifica. Não pode ser superior a 255 caracteres. Ex: exemplo

subtipo   string  opcional  

Ex: exemplo

MDA / SEAD / Declaração de Aptidão Ao PRONAF (DAP)

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 90402879708

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 17601559000170

MPE - Certidão de Inquérito Civil

POST /services/{serviceId}/available-formats

url_uf   string   

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

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 10508651549

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 97103653000138

nome   string   

Não pode ser superior a 255 caracteres. Ex: Dr. Hugo Lucio de Aguiar

url_uf   string   

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

MPE - Certidão de Inquérito Criminal

POST /services/{serviceId}/available-formats

url_uf   string   

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

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 84510251610

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 39807958000124

nome   string   

Não pode ser superior a 255 caracteres. Ex: Sra. Stefany Marin

url_uf   string   

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

MPF - Certidão Negativa

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 39156120737

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 94712987000110

MPT - Certidão Negativa de Feitos

POST /services/{serviceId}/available-formats

url_uf   string   

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

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 35124208937

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 95325452000150

nome   string   

Não pode ser superior a 255 caracteres. Ex: Jaqueline Lourenço Correia

url_uf   string   

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

MT - Certidão de Cumprimento da Cota Legal de PcDs

POST /services/{serviceId}/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. Ex: 51378087000176

MT - Certidão de Débitos

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 92911110820

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 81402632000183

MT - Recibo de Entrega da Rais

POST /services/{serviceId}/available-formats

tipo   string   

Ex: cei-cno

Deve ser um destes:
  • cei-cno
  • caepf
  • cnpj

POST /services/{serviceId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo   string   

Ex: cei-cno

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   

Ex: cei-cno

Deve ser um destes:
  • cei-cno
  • caepf
  • cnpj
cei_cno   string  opcional  

Este campo é obrigatório quando tipo for cei-cno. Ex: exemplo

caepf   string  opcional  

Este campo é obrigatório quando tipo for caepf. Ex: exemplo

cnpj   string  opcional  

Este campo é obrigatório quando tipo for cnpj. Ex: 26708087000140

crea   string   

Ex: exemplo

ano_base   integer   

Deve ser entre 1900 e 2026. Ex: 1963

Receita Federal - Certidão de Tributos Federais e Dívida da União de Imóvel Rural (ITR)

POST /services/{serviceId}/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. Ex: exemplo

Receita Federal - Certidão Negativa de Débitos Relativos Aos Tributos Federais e à Divida Ativa da União (CNDTNIDA)

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 29411616518

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 42641217000120

nascimento   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser uma data válida no formato Y-m-d. Deve ser uma data anterior ou igual a hoje. Ex: 1989-12-15

SEFAZ - Certidão de IPTU

POST /services/{serviceId}/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}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 19878017176

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 13504743000140

inscricao_imovel   string   

Não pode ser superior a 255 caracteres. Ex: exemplo

complemento   string  opcional  

Não pode ser superior a 250 caracteres. Ex: Apto 12

SEFAZ - Certidão Negativa de Débitos Tributários Estaduais (CND Estadual)

POST /services/{serviceId}/available-formats

url_uf   string   

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

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 82763718922

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 88568086000102

nome   string   

Não pode ser superior a 255 caracteres. Ex: Dr. Carlos Cordeiro Filho

url_uf   string   

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

rg   string  opcional  

Ex: 380181584

orgao_emissor   string  opcional  

Ex: exemplo

SEFAZ - Certidão Negativa de Débitos Tributários Municipais (CND Municipal)

POST /services/{serviceId}/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}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 42033154173

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 05770655000162

nome   string   

Não pode ser superior a 255 caracteres. Ex: Dr. Marcelo Carmona Vale Sobrinho

mae   string  opcional  

Não pode ser superior a 255 caracteres. Ex: Sônia Caldeira

nascimento   string  opcional  

Deve ser uma data válida no formato Y-m-d. Ex: 2019-06-11

inscricao_municipal   string  opcional  

Não pode ser superior a 255 caracteres. Não pode ser superior a 255 caracteres. Ex: exemplo

inscricao_mercantil   string  opcional  

Este campo é obrigatório quando url_uf for PE. Não pode ser superior a 255 caracteres. Ex: exemplo

inscricao_cadastral   string  opcional  

Este campo é obrigatório quando url_cidade for santana-de-parnaiba. Não pode ser superior a 255 caracteres. Ex: exemplo

observacoes   string  opcional  

Não pode ser superior a 2500 caracteres. Ex: exemplo

endereco_cep   string  opcional  

Não pode ser superior a 8 caracteres. Ex: exemplo

endereco_logradouro   string  opcional  

Não pode ser superior a 120 caracteres. Ex: exemplo

endereco_numero   string  opcional  

Não pode ser superior a 10 caracteres. Ex: exemplo

endereco_complemento   string  opcional  

Não pode ser superior a 60 caracteres. Ex: exemplo

endereco_bairro   string  opcional  

Não pode ser superior a 80 caracteres. Ex: exemplo

endereco_cidade   string  opcional  

Não pode ser superior a 120 caracteres. Ex: exemplo

endereco_uf   string  opcional  

Ex: AC

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

STF - Certidão Distribuidor

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 33461534790

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 60541132000152

nome   string   

Não pode ser superior a 255 caracteres. Ex: Sra. Eloah Matos Aguiar

mae   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Não pode ser superior a 255 caracteres. Ex: Srta. Paloma da Cruz Filho

nascimento   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser uma data válida no formato Y-m-d. Ex: 2010-10-16

pai   string  opcional  

Não pode ser superior a 255 caracteres. Ex: Dr. Manuel Nelson D'ávila Neto

rg   string  opcional  

Ex: 179976214

orgao_emissor   string  opcional  

Ex: exemplo

nacionalidade   string  opcional  

Ex: exemplo

estado_civil   string  opcional  

Ex: exemplo

STJ - Certidão Negativa

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 62180959915

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 03060100000100

nome   string   

Não pode ser superior a 255 caracteres. Ex: Angélica Juliane Pedrosa

STM - Certidão Negativa de Ações Criminais

POST /services/{serviceId}/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. Ex: 91812878281

nome   string   

Não pode ser superior a 255 caracteres. Ex: Heloísa Torres

nascimento   string   

Deve ser uma data válida no formato Y-m-d. Deve ser uma data anterior ou igual a hoje. Ex: 1977-11-09

mae   string   

Ex: Marília Gabi Perez

TCU - Certidão Negativa de Contas Julgadas Irregulares

POST /services/{serviceId}/available-formats

tipo   string   

Ex: exemplo

POST /services/{serviceId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo   string   

Ex: exemplo

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 87539783230

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 37961789000157

nome   string   

Não pode ser superior a 255 caracteres. Ex: Dr. Maicon Valência Neto

tipo   string   

Ex: exemplo

TCU - Certidão Negativa de Processo

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 84603704372

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 46298441000112

nome   string   

Não pode ser superior a 255 caracteres. Ex: Sérgio Rosa Ortiz Neto

TJ - Certidão de Distribuição Estadual

POST /services/{serviceId}/available-formats

url_uf   string   

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

POST /services/{serviceId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   

Ex: fisica

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. Ex: exemplo

modelo   string   

Não pode ser superior a 255 caracteres. Ex: exemplo

POST /services/{serviceId}/extra-informations

tipo_pessoa   string   

Ex: fisica

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. Ex: exemplo

modelo   string   

Não pode ser superior a 255 caracteres. Ex: exemplo

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 94121906624

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 66395792000159

url_uf   string   

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

nome   string  opcional  

Ex: Tiago Martines Ramos

pai   string  opcional  

Não pode ser superior a 255 caracteres. Ex: Sr. Denis Fabrício Arruda Neto

mae   string  opcional  

Não pode ser superior a 255 caracteres. Ex: Michele Carmona

nascimento   string  opcional  

Deve ser uma data válida no formato Y-m-d. Ex: 1971-02-03

rg   string  opcional  

Não pode ser superior a 20 caracteres. Ex: 227664698

endereco   string  opcional  

Não pode ser superior a 500 caracteres. Ex: R. Rafaela, 1. 9º Andar

naturalidade   string  opcional  

Não pode ser superior a 500 caracteres. Ex: exemplo

nacionalidade   string  opcional  

Não pode ser superior a 255 caracteres. Ex: exemplo

estado_civil   string  opcional  

Não pode ser superior a 255 caracteres. Ex: exemplo

instancia   string   

Não pode ser superior a 255 caracteres. Ex: exemplo

modelo   string   

Não pode ser superior a 255 caracteres. Ex: exemplo

comarca   string  opcional  

Não pode ser superior a 255 caracteres. Ex: exemplo

representante_legal   string  opcional  

Não pode ser superior a 255 caracteres. Ex: exemplo

orgao_expedidor_rg   string  opcional  

Não pode ser superior a 255 caracteres. Ex: exemplo

arquivos   string[]   

Um array com o caminho dos arquivos enviados no endpoint de upload: link

TRF - Certidão de Distribuição da Justiça Federal

POST /services/{serviceId}/available-formats

tipo_pessoa   string   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
regiao   string   

Ex: 1_regiao

Deve ser um destes:
  • 1_regiao
  • 2_regiao
  • 3_regiao
  • 4_regiao
  • 5_regiao
  • 6_regiao

POST /services/{serviceId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
regiao   string   

Ex: 1_regiao

Deve ser um destes:
  • 1_regiao
  • 2_regiao
  • 3_regiao
  • 4_regiao
  • 5_regiao
  • 6_regiao

POST /services/{serviceId}/extra-informations

tipo_pessoa   string   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
regiao   string   

Ex: 1_regiao

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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 26263074833

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 49125427000105

nome   string   

Não pode ser superior a 255 caracteres. Ex: Andressa Dias Pena

regiao   string   

Ex: 1_regiao

Deve ser um destes:
  • 1_regiao
  • 2_regiao
  • 3_regiao
  • 4_regiao
  • 5_regiao
  • 6_regiao
orgao   string  opcional  

Este campo é obrigatório quando regiao for 1_regiao, 3_regiao, or 6_regiao. Ex: exemplo

tipo   string   

Ex: exemplo

Tribunal de Contas Estadual

POST /services/{serviceId}/available-formats

url_uf   string   

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

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 84049846977

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 06383045000179

nome   string   

Não pode ser superior a 255 caracteres. Ex: Dr. Mauro Fidalgo

url_uf   string   

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

TRT - Certidão de Ações Trabalhistas (CEAT)

POST /services/{serviceId}/available-formats

regiao   string   

Não pode ser superior a 255 caracteres. Ex: exemplo

POST /services/{serviceId}/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. Ex: exemplo

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 22282644824

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 63633889000164

nome   string   

Não pode ser superior a 255 caracteres. Ex: Sr. Matias Bezerra Filho

regiao   string   

Não pode ser superior a 255 caracteres. Ex: exemplo

modelo   string  opcional  

Não pode ser superior a 255 caracteres. Ex: exemplo

TSE - Certidão de Quitação Eleitoral

POST /services/{serviceId}/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. Ex: William Zaragoça Maia Filho

pai   string  opcional  

Não pode ser superior a 255 caracteres. Ex: Jorge Santiago Madeira Jr.

mae   string  opcional  

Não pode ser superior a 255 caracteres. Ex: Dr. Antonella Mayara Chaves Neto

nascimento   string   

Deve ser uma data válida no formato Y-m-d. Deve ser uma data anterior ou igual a hoje. Ex: 1991-01-24

documento   string   

Deve ter pelo menos 11 caracteres. Não pode ser superior a 12 caracteres. Ex: exemplo

TST - Certidão Negativa de Débitos Trabalhistas (CNDT)

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 65288239959

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 67841781000118

Consulta - Cadastro Técnico Federal do IBAMA

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 50774266007

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 57644055000151

Consulta Certificado de Cadastro do Imóvel Rural (CCIR)

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 34214389352

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 39836712000180

nome   string   

Não pode ser superior a 255 caracteres. Ex: Sra. Rayane Serrano Maia

Consulta de Dados Cadastrais

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 96696376194

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 24038239000119

nome   string   

Não pode ser superior a 255 caracteres. Ex: Sr. Filipe Corona Filho

pedido_origem_id   integer  opcional  

Deve corresponder a um valor já cadastrado. Ex: 95

Consulta de Taxa de Incêndio

POST /services/{serviceId}/available-formats

url_uf   string   

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

POST /services/{serviceId}/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

cbmerj   string  opcional  

Este campo é obrigatório quando nenhum de inscricao_imovel, cpf, and cnpj estiverem presentes. Não pode ser superior a 40 caracteres. Ex: exemplo

inscricao_imovel   string  opcional  

Este campo é obrigatório quando nenhum de cbmerj, cpf, and cnpj estiverem presentes. Não pode ser superior a 40 caracteres. Ex: exemplo

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

cpf   string  opcional  

Este campo é obrigatório quando nenhum de cbmerj, inscricao_imovel, and cnpj estiverem presentes. Deve ser 11 caracteres. Ex: 22323972464

cnpj   string  opcional  

Este campo é obrigatório quando nenhum de cbmerj, inscricao_imovel, and cpf estiverem presentes. Deve ser 14 caracteres. Ex: 46814017000183

Consulta SICAF (Sistema de Cadastramento Unificado de Fornecedores)

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 31366195442

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 15536451000115

Débitos e Multas

POST /services/{serviceId}/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

placa   string  opcional  

Este campo é obrigatório quando chassi for not present. Ex: exemplo

chassi   string  opcional  

Este campo é obrigatório quando placa for not present. Deve ser 17 caracteres. Ex: exemplo

Funcionamento Empresa (Anvisa)

POST /services/{serviceId}/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. Ex: 70501460000189

razao_social   string  opcional  

Não pode ser superior a 500 caracteres. Ex: Camacho e Vega e Associados

Mapa de Relacionamentos

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 59890384965

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 94691994000183

Pesquisa Cadastro Ambiental Rural (CAR)

POST /services/{serviceId}/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})\$/. Ex: exemplo

Pesquisa Central de Distribuição de Títulos de São Paulo - CDTSP

POST /services/{serviceId}/available-formats

tipo   string   

Ex: exemplo

modalidade   string   

Ex: exemplo

POST /services/{serviceId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo   string   

Ex: exemplo

modalidade   string   

Ex: exemplo

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 66967186728

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 87867083000107

nome   string   

Não pode ser superior a 255 caracteres. Ex: Talita Aranda Carmona

tipo   string   

Ex: exemplo

modalidade   string   

Ex: exemplo

descricao   string   

Não pode ser superior a 1000 caracteres. Ex: exemplo

ano_inicial   integer  opcional  

Deve ser entre 1900 e 2026. Ex: 1963

Pesquisa de Bens

POST /services/{serviceId}/available-formats

url_uf   string   

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

POST /services/{serviceId}/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   

Ex: exemplo

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 96667377102

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 58358961000152

nome   string   

Não pode ser superior a 255 caracteres. Ex: Srta. Franciele Franciele Campos

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[]   

Ex: serventias-extrajudiciais-da-comarca-de-acrelandia-centro-acrelandia

tipo   string   

Ex: exemplo

preferencia   string  opcional  

Ex: Informar somente imóveis que seja proprietário

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 no formato Y-m-d. Ex: 2006-11-08

Pesquisa de Casamento

POST /services/{serviceId}/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. Ex: exemplo

conjuge2   string   

Não pode ser superior a 255 caracteres. Ex: exemplo

casamento   string   

Deve ser uma data válida no formato Y-m-d. Deve ser uma data anterior ou igual a hoje. Ex: 2000-11-02

cpf_algum_conjuges   string   

Deve ser 11 caracteres. Ex: exemplo

Pesquisa de CPF por Nome

POST /services/{serviceId}/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. Ex: João Wagner Roque Jr.

Pesquisa de Dívida Ativa - Procuradoria Geral do Estado

POST /services/{serviceId}/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   

Ex: exemplo

POST /services/{serviceId}/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   

Ex: exemplo

inscricao   string   

Ex: exemplo

Pesquisa de Empresa em Cartórios de Pessoa Jurídica

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 16872866209

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 00359889000106

nome   string   

Não pode ser superior a 255 caracteres. Ex: Bia Benites Rico Neto

Pesquisa de Escritura

POST /services/{serviceId}/available-formats

tipo   string   

Ex: exemplo

POST /services/{serviceId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo   string   

Ex: exemplo

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 22002767530

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 69230248000145

nome   string   

Não pode ser superior a 255 caracteres. Ex: Ana Queirós Rios

tipo   string   

Ex: exemplo

Pesquisa de Escritura de Divórcio

POST /services/{serviceId}/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. Ex: 54001972727

nome   string   

Não pode ser superior a 255 caracteres. Ex: Sra. Katherine Lívia Padilha Jr.

Pesquisa de Indicadores de Atividade

POST /services/{serviceId}/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. Ex: 73168082000151

Pesquisa de Inventário

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 51585421472

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 77863863000117

nome   string   

Não pode ser superior a 255 caracteres. Ex: Diana Emanuelly Perez Sobrinho

Pesquisa de KYC e Compliance

POST /services/{serviceId}/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. Ex: 40846923360

nome   string   

Não pode ser superior a 255 caracteres. Ex: Joaquin Sérgio Casanova

Pesquisa de Licenças - Vigilância Sanitária (SIVISA)

POST /services/{serviceId}/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}/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

cnpj   string   

Deve ser 14 caracteres. Ex: 22168638000179

Pesquisa de Lista de Devedores PGFN

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 19419597687

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 54264952000141

nome   string   

Não pode ser superior a 255 caracteres. Ex: Máximo Lutero Vale

Pesquisa de Nascimento

POST /services/{serviceId}/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. Ex: 78593196756

nome   string   

Não pode ser superior a 255 caracteres. Ex: Taís Gonçalves

nascimento   string   

Deve ser uma data válida no formato Y-m-d. Deve ser uma data anterior ou igual a hoje. Ex: 1981-08-03

mae   string   

Não pode ser superior a 255 caracteres. Ex: Dr. Carolina Soares Salgado Sobrinho

pai   string  opcional  

Não pode ser superior a 255 caracteres. Ex: Breno Richard Benez

Pesquisa de Óbito

POST /services/{serviceId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo   string   

Ex: simples

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   

Ex: 67262277871

tipo   string   

Ex: simples

Deve ser um destes:
  • simples
  • expandida
  • completa

Pesquisa de Participação Societária

POST /services/{serviceId}/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. Ex: 27235825073

nome   string   

Não pode ser superior a 255 caracteres. Ex: Dr. Naomi Santacruz

nascimento   string  opcional  

Deve ser uma data válida no formato Y-m-d. Deve ser uma data anterior ou igual a hoje. Ex: 1979-05-18

Pesquisa de Processos Judiciais

POST /services/{serviceId}/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  

Este campo é obrigatório quando numero_processo for not present. Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
numero_processo   string  opcional  

Este campo é obrigatório quando tipo_pessoa for not present. Deve atender a regex /\^[0-9]+\$/. Não pode ser superior a 50 caracteres. Ex: exemplo

cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 31216227578

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 57220881000173

nome   string  opcional  

Este campo é obrigatório quando tipo_pessoa for present. Não pode ser superior a 255 caracteres. Ex: Estela Garcia

pedido_origem_id   integer  opcional  

Deve corresponder a um valor já cadastrado. Ex: 222

Pesquisa de Procuração

POST /services/{serviceId}/available-formats

tipo   string   

Ex: exemplo

POST /services/{serviceId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo   string   

Ex: exemplo

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo_pessoa   string   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 04497116336

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 88033663000153

nome   string   

Não pode ser superior a 255 caracteres. Ex: Thaís Jennifer Rangel Filho

tipo   string   

Ex: exemplo

Pesquisa de Propriedade de Aeronave

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 38971178434

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 64721827000177

nome   string   

Não pode ser superior a 255 caracteres. Ex: Srta. Stephanie Gabrielly Lovato Filho

Pesquisa de Propriedade de Veículo

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 01425371108

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 57977940000152

nome   string   

Não pode ser superior a 255 caracteres. Ex: Malena Pacheco Salazar Sobrinho

Pesquisa de Protesto

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 87243325696

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 88551134000141

Pesquisa de Veículos

POST /services/{serviceId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo   string   

Ex: leilao

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   

Ex: leilao

Deve ser um destes:
  • leilao
  • pesquisa-completa
  • gravame
placa   string   

Ex: exemplo

Pesquisa em Juntas Comerciais

POST /services/{serviceId}/available-formats

url_uf   string   

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

POST /services/{serviceId}/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   

Deve ser 14 caracteres. Ex: 22774863000159

razao_social   string   

Não pode ser superior a 500 caracteres. Ex: Camacho e Pereira Ltda.

Pesquisa SERASA

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 63052011537

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 23016197000152

Receita Federal - CPF | CNPJ

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 41555656765

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 20207553000127

nascimento   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser uma data válida no formato Y-m-d. Ex: 2004-06-23

SINTEGRA - Consulta Pública Ao Cadastro de Contribuinte do Governo

POST /services/{serviceId}/available-formats

url_uf   object   

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

POST /services/{serviceId}/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. Ex: 58718959000147

SPU - Pesquisa de Imóveis da União

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 83699345440

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 23164893000106

TCU - Consulta Situação de Pessoa Jurídica

POST /services/{serviceId}/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. Ex: 30664398000121

Acompanhamentos

POST /services/{serviceId}/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}/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}/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   

Ex: exemplo

arquivos   string[]   
tipo_processo   string   

Ex: digital

Deve ser um destes:
  • digital
  • fisico
numero_processo   string  opcional  

Ex: exemplo

mensagem   string  opcional  

Não pode ser superior a 500 caracteres. Ex: exemplo

Ata Notarial

POST /services/{serviceId}/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}/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}/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   

Ex: exemplo

mensagem   string  opcional  

Não pode ser superior a 500 caracteres. Ex: exemplo

arquivos   string[]   

Consultas

POST /services/{serviceId}/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}/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}/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   

Ex: exemplo

arquivos   string[]   
tipo_processo   string   

Ex: digital

Deve ser um destes:
  • digital
  • fisico
numero_processo   string  opcional  

Ex: exemplo

mensagem   string  opcional  

Não pode ser superior a 500 caracteres. Ex: exemplo

Cópias

POST /services/{serviceId}/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}/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}/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   

Ex: exemplo

arquivos   string[]   
numero_processo   string  opcional  

Ex: exemplo

mensagem   string  opcional  

Não pode ser superior a 500 caracteres. Ex: exemplo

Guias

POST /services/{serviceId}/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}/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}/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   

Ex: exemplo

arquivos   string[]   
tipo_processo   string   

Ex: digital

Deve ser um destes:
  • digital
  • fisico
numero_processo   string  opcional  

Ex: exemplo

mensagem   string  opcional  

Não pode ser superior a 500 caracteres. Ex: exemplo

Outras

POST /services/{serviceId}/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}/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}/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   

Ex: exemplo

mensagem   string  opcional  

Não pode ser superior a 500 caracteres. Ex: exemplo

arquivos   string[]   

Prévia de Custas para Registros

POST /services/{serviceId}/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}/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}/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   

Ex: exemplo

arquivos   string[]   
mensagem   string  opcional  

Não pode ser superior a 500 caracteres. Ex: exemplo

descritivo_documento   string  opcional  

Ex: exemplo

Protocolos

POST /services/{serviceId}/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}/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}/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   

Ex: exemplo

arquivos   string[]   
tipo_processo   string   

Ex: digital

Deve ser um destes:
  • digital
  • fisico
numero_processo   string  opcional  

Ex: exemplo

mensagem   string  opcional  

Não pode ser superior a 500 caracteres. Ex: exemplo

Registro de Imóveis

POST /services/{serviceId}/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}/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}/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   

Ex: exemplo

arquivos   string[]   
mensagem   string  opcional  

Não pode ser superior a 500 caracteres. Ex: exemplo

descritivo_documento   string  opcional  

Ex: exemplo

Requerimentos

POST /services/{serviceId}/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}/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}/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   

Ex: exemplo

arquivos   string[]   
tipo_processo   string   

Ex: digital

Deve ser um destes:
  • digital
  • fisico
numero_processo   string  opcional  

Ex: exemplo

mensagem   string  opcional  

Não pode ser superior a 500 caracteres. Ex: exemplo

Retirada de Documentos

POST /services/{serviceId}/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}/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}/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   

Ex: exemplo

arquivos   string[]   
numero_processo   string  opcional  

Ex: exemplo

mensagem   string  opcional  

Não pode ser superior a 500 caracteres. Ex: exemplo

Serviços de Despachantes

POST /services/{serviceId}/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}/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}/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   

Ex: exemplo

arquivos   string[]   
mensagem   string  opcional  

Não pode ser superior a 500 caracteres. Ex: exemplo

Extração de Dados

POST /services/{serviceId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

arquivos   object   

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

arquivos   string[]   

Um array com os caminhos dos arquivos enviados no endpoint de upload: link

modelo_ia_id   integer   

O modelo de extração de dados desejado. Disponíveis podem ser obtidos em link Ex: 130

Ata Notarial - Lavratura em Tabelionato de Notas

POST /services/{serviceId}/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}/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   

Ex: diligencia-presencial-do-tabeliao

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  

Este campo é obrigatório quando tipo_servico for diligencia-presencial-do-tabeliao. Não pode ser superior a 500 caracteres. Ex: exemplo

mensagem   string   

Não pode ser superior a 500 caracteres. Ex: exemplo

tipo_servico   string   

Ex: diligencia-presencial-do-tabeliao

Deve ser um destes:
  • diligencia-presencial-do-tabeliao
  • ja-possuo-as-evidencias
arquivos   string[]   

RGI - Registro em Cartório de Imóveis

POST /services/{serviceId}/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}/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 no formato Y-m-d. Ex: 2010-04-12

livro   string  opcional  

Não pode ser superior a 5 caracteres. Ex: exemplo

pagina   string  opcional  

Não pode ser superior a 3 caracteres. Ex: exemplo

assinantes   object[]  opcional  
partes   array  opcional  

Este campo é obrigatório quando tipo for escritura-publica. Quando informado deve existir ao menos 1 outorgante e 1 outorgado.

tipo   string   

Ex: exemplo

observacoes   string  opcional  

Não pode ser superior a 500 caracteres. Ex: exemplo

arquivos[].caminho_arquivo   string   

O caminho do arquivos enviado no endpoint de upload: link. Ex: exemplo

arquivos[].vai_registro   boolean   

Indica se o arquivo deve ser registrado. Ex: true

arquivos[].requer_assinatura   boolean   

Indica se o arquivo requer assinatura. Ex: true

assinantes[].cpf   string   

Ex: 59272812224

assinantes[].email   string   

Deve ser um endereço de e-mail válido. Ex: roberta12@example.org

assinantes[].nome   string   

Não pode ser superior a 255 caracteres. Ex: Sr. Everton Diogo Sandoval

partes[].documento   string   

Ex: exemplo

partes[].email   string   

Deve ser um endereço de e-mail válido. Ex: zambrano.aline@example.org

partes[].nome   string   

Não pode ser superior a 255 caracteres. Ex: Davi Arthur Madeira

partes[].tipo   string   

Ex: outorgante

Deve ser um destes:
  • outorgante
  • outorgado

RTD - Registro em Cartório de Títulos e Documentos

POST /services/{serviceId}/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}/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. Ex: exemplo

observacoes   string  opcional  

Não pode ser superior a 500 caracteres. Ex: exemplo

arquivos[].caminho_arquivo   string   

O caminho do arquivos enviado no endpoint de upload: link. Ex: exemplo

arquivos[].vai_registro   boolean   

Indica se o arquivo deve ser registrado. Ex: true

arquivos[].requer_assinatura   boolean   

Indica se o arquivo requer assinatura. Ex: true

assinantes[].cpf   string   

Somente números. Ex: 05306626718

assinantes[].email   string   

Deve ser um endereço de e-mail válido. Ex: martinho66@example.com

assinantes[].nome   string   

Não pode ser superior a 255 caracteres. Ex: Ronaldo Wellington Batista

Assinaturas para Documentos

POST /services/{serviceId}/available-formats

tipo   string   

Ex: exemplo

POST /services/{serviceId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo   string   

Ex: exemplo

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

tipo   string   

Ex: exemplo

arquivos   string[]   
assinantes   string   

Deve ter pelo menos 1 caracter. Ex: exemplo

assinantes[].cpf   string   

Ex: 13030344096

assinantes[].email   string   

Deve ser um endereço de e-mail válido. Ex: qmatias@example.org

assinantes[].nome   string   

Não pode ser superior a 255 caracteres. Ex: Dr. Aaron Bernardo Santana

Certificado Digital

POST /services/{serviceId}/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. Ex: 75377616804

nome   string   

Não pode ser superior a 255 caracteres. Ex: Dr. Melissa Flores de Aguiar Neto

nascimento   string   

Deve ser uma data válida no formato Y-m-d. Deve ser uma data anterior ou igual a hoje. Ex: 1999-12-19

tipo   string   

Ex: presencial

Deve ser um destes:
  • presencial
  • telepresencial
endereco   string  opcional  

Este campo é obrigatório quando tipo for presencial. Não pode ser superior a 255 caracteres. Ex: Avenida Aguiar, 5. Bloco C

email   string   

Deve ser um endereço de e-mail válido. Não pode ser superior a 255 caracteres. Ex: aline.montenegro@example.com

telefone   string   

Não pode ser superior a 15 caracteres. Ex: 4842365258

Certidão de Casamento

POST /services/{serviceId}/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 Ex: exemplo

Certidão de Imóvel - Matrícula

POST /services/{serviceId}/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 Ex: exemplo

Certidão de Imóvel - Transcrição

POST /services/{serviceId}/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 Ex: exemplo

Certidão de Nascimento

POST /services/{serviceId}/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 Ex: exemplo

Certidão de Óbito

POST /services/{serviceId}/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 Ex: exemplo

Dossiê CPF/CNPJ

POST /services/{serviceId}/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   

Ex: fisica

Deve ser um destes:
  • fisica
  • juridica
cpf   string  opcional  

Este campo é obrigatório quando tipo_pessoa for fisica. Deve ser 11 caracteres. Ex: 54654330194

cnpj   string  opcional  

Este campo é obrigatório quando tipo_pessoa for juridica. Deve ser 14 caracteres. Ex: 06599127000155

Certidão de Casamento

POST /services/{serviceId}/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 Ex: exemplo

Certidão de Escritura

POST /services/{serviceId}/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 Ex: exemplo

Certidão de Nascimento

POST /services/{serviceId}/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 Ex: exemplo

CNH (Carteira Nacional de Habilitação)

POST /services/{serviceId}/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 Ex: exemplo

CNIS - Extrato de contribuição

POST /services/{serviceId}/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 Ex: exemplo

CTPS (Carteira de Trabalho e Previdência Social)

POST /services/{serviceId}/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 Ex: exemplo

Tradução e Apostilamento

POST /services/{serviceId}/available-formats

servico   string   

Ex: exemplo

POST /services/{serviceId}/prices-shipping-info

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

servico   string   

Ex: exemplo

POST /purchases

formato   string   

O formato de entrega. Disponíveis podem ser obtidos em link Ex: email

servico   string   

Ex: exemplo

traducao   string  opcional  

Ex: exemplo

arquivo   string   

Ex: exemplo

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, até um máximo de 50 arquivos e 70Mb. 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
        }
        // 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. Será feito um POST para a url informada. Os dados enviados no payload vão no mesmo formato do retorno exemplificado acima. O endpoint do webhook pode ser público ou ter alguma das seguintes autenticações: - Autenticação básica (Basic Auth) - Token de acesso (Bearer Token)

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, até um máximo de 50 arquivos e 70Mb. 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
        },
        {
            // 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
        }
        // 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. Será feito um POST para a url informada. Os dados enviados no payload vão no mesmo formato do retorno exemplificado acima. O endpoint do webhook pode ser público ou ter alguma das seguintes autenticações: - Autenticação básica (Basic Auth) - Token de acesso (Bearer Token)

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, até um máximo de 50 arquivos e 70Mb. 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
        },
        {
            // 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
        }
        // 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. Será feito um POST para a url informada. Os dados enviados no payload vão no mesmo formato do retorno exemplificado acima. O endpoint do webhook pode ser público ou ter alguma das seguintes autenticações: - Autenticação básica (Basic Auth) - Token de acesso (Bearer Token)

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
        }
        // 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. Será feito um POST para a url informada. Os dados enviados no payload vão no mesmo formato do retorno exemplificado acima. O endpoint do webhook pode ser público ou ter alguma das seguintes autenticações: - Autenticação básica (Basic Auth) - Token de acesso (Bearer Token)

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
        }
        // 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. Será feito um POST para a url informada. Os dados enviados no payload vão no mesmo formato do retorno exemplificado acima. O endpoint do webhook pode ser público ou ter alguma das seguintes autenticações: - Autenticação básica (Basic Auth) - Token de acesso (Bearer Token)

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
        }
    ]
}

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. Será feito um POST para a url informada. Os dados enviados no payload vão no mesmo formato do retorno exemplificado acima. O endpoint do webhook pode ser público ou ter alguma das seguintes autenticações: - Autenticação básica (Basic Auth) - Token de acesso (Bearer Token)

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
        }
        // 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. Será feito um POST para a url informada. Os dados enviados no payload vão no mesmo formato do retorno exemplificado acima. O endpoint do webhook pode ser público ou ter alguma das seguintes autenticações: - Autenticação básica (Basic Auth) - Token de acesso (Bearer Token)

Validação de documentos

Abaixo encontra-se um resumo com os passos para utilizar a validação de documentos 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) Fazer o upload dos arquivos que deseja a validação

Antes de efetuar a compra você vai enviar o arquivo que deseja validar.

Você pode enviar um ou múltiplos arquivos de uma vez, até um máximo de 50 arquivos e 70Mb. 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

3) 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 validação.

O service_id pode ser obtido na listagem de serviços link. 


// 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 validação", // Nome deste item do carrinho
            "detailed_service_data": {
                "arquivo": "1234/yKAwE5FKrHTi5VtF1Zt5hOvG8MtRD4pxrNWrMrCC.pdf", // Caminho do arquivo obtido no passo 2
                "formato": "email" // fixo
            },
            "service_id": 150
        },
    {
            "name": "Minha validação 2", // Nome deste item do carrinho
            "detailed_service_data": {
                "arquivo": "1234/1273Ti5VtF1Zt5hOvG8MtRD4pxrNWrMrCC.pdf", // Caminho do arquivo obtido no passo 2
                "formato": "email" // fixo
            },
            "service_id": 151
        }
        // 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 validação",
            ...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": "Minha validação 2",
            ...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 o campo result vai indicar se o documento é válido. 

// endpoint => GET https://api2.cbrdoc.com.br/orders/12345

Retorno positivo (válido):
{
    "status": "finished",
    "result": "positive", // ou "negative" para inválido
    "result_details": [], // em caso de "negativa" aqui vai ter os detalhes do erro, em alguns serviços
    ...outros dados do item da compra
}

OU

// endpoint => GET https://api2.cbrdoc.com.br/orders/12345

Retorno negativo (inválido):
{
    "status": "finished",
    "result": "negative",
    "result_details": [ // serviço de validação de CNH e Carteira de trabalho apresentam detalhes da validação
        "validacoes": [
            "-904" => "Valida se a idade na primeira habilitação é menor que 18 anos (inválido)",
            "-912" => "Verifica se a data de nascimento é posterior à data de expedição (inconsistência)",
        ]
    ],
    ...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. Será feito um POST para a url informada. Os dados enviados no payload vão no mesmo formato do retorno exemplificado acima. O endpoint do webhook pode ser público ou ter alguma das seguintes autenticações: - Autenticação básica (Basic Auth) - Token de acesso (Bearer Token)