Conta

Saldo e orçamento.

Consultar o saldo da conta

GET

https://api.consultas.us

/balance

Devolve o saldo da carteira, o modo de cobrança e as unidades de pacotes e cortesias ainda válidas. Não cobra.

Consultar o saldo da conta › Responses

O saldo atual.

RespostaDeSaldo

success

const · required

Const value:

modo

string · enum · required

Enum values:

pre_pago

pos_pago

saldo_brl

number

limite_credito_brl

number | null

UnidadeDeSaldo[]

Orçar uma consulta antes de executá-la

POST

https://api.consultas.us

/estimate

Diz quanto uma consulta custaria, de onde ela sairia (carteira, pacote ou cortesia), se a entrada está completa e se aquele documento já está no seu histórico. Não cobra e não executa nada.

Orçar uma consulta antes de executá-la › Request Body

consultation_type

string · required

O identificador da consulta. O que a sua conta pode consultar sai em GET /catalog; o contrato de entrada de cada uma está em components.schemas, como Entrada_<slug>.

Example: antecedentes-cpf

object · required

Os campos que a consulta exige. Variam por produto — veja Entrada_<slug> ou o campo input_schema do GET /catalog.

Orçar uma consulta antes de executá-la › Responses

O orçamento.

RespostaDeOrcamento

success

const · required

Const value:

slug

string · required

preco_efetivo_brl

number · required

fonte_de_pagamento_prevista

string | null

De onde o pagamento sairia.

saldo_suficiente

boolean | null

liberado

boolean

ja_no_historico

boolean | null

Se aquele documento já foi consultado. null quando não dá para saber.

object

POST/estimate

curl https://api.consultas.us/estimate \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "consultation_type": "antecedentes-cpf",
  "input_data": {
    "cpf": "11144477735"
  }
}'

Example Request Body

{
  "consultation_type": "antecedentes-cpf",
  "input_data": {
    "cpf": "11144477735"
  }
}

json

application/json

Example Responses

{
  "success": true,
  "slug": "slug",
  "preco_efetivo_brl": 0,
  "fonte_de_pagamento_prevista": "fonte_de_pagamento_prevista",
  "saldo_suficiente": true,
  "liberado": true,
  "ja_no_historico": true,
  "validacao": {
    "ok": true,
    "campos_faltando": [
      "string"
    ],
    "formatos": {},
    "mensagem": "mensagem"
  }
}

json

application/json

Catálogo Distribuidor

Consultar o saldo da conta

GET

https://api.consultas.us

/balance

Devolve o saldo da carteira, o modo de cobrança e as unidades de pacotes e cortesias ainda válidas. Não cobra.

Consultar o saldo da conta › Responses

O saldo atual.

RespostaDeSaldo

success

const · required

Const value:

modo

string · enum · required

Enum values:

pre_pago

pos_pago

saldo_brl

number

limite_credito_brl

number | null

UnidadeDeSaldo[]

Orçar uma consulta antes de executá-la

POST

https://api.consultas.us

/estimate

Diz quanto uma consulta custaria, de onde ela sairia (carteira, pacote ou cortesia), se a entrada está completa e se aquele documento já está no seu histórico. Não cobra e não executa nada.

Orçar uma consulta antes de executá-la › Request Body

consultation_type

string · required

O identificador da consulta. O que a sua conta pode consultar sai em GET /catalog; o contrato de entrada de cada uma está em components.schemas, como Entrada_<slug>.

Example: antecedentes-cpf

object · required

Os campos que a consulta exige. Variam por produto — veja Entrada_<slug> ou o campo input_schema do GET /catalog.

Orçar uma consulta antes de executá-la › Responses

O orçamento.

RespostaDeOrcamento

success

const · required

Const value:

slug

string · required

preco_efetivo_brl

number · required

fonte_de_pagamento_prevista

string | null

De onde o pagamento sairia.

saldo_suficiente

boolean | null

liberado

boolean

ja_no_historico

boolean | null

Se aquele documento já foi consultado. null quando não dá para saber.

object