Skip to main content
GET
/
api
/
pessoa
/
credito
Consultar crédito
curl --request GET \
  --url https://sandboxapi.mycredit.com.br/api/pessoa/credito \
  --header 'Authorization: Bearer <token>'
{
  "sucesso": true,
  "data": {
    "empresaDocumento": "99999999999999",
    "pessoaDocumento": "99999999999",
    "limite": 1000,
    "disponivel": 211.41,
    "validade": "2026-08-20T09:24:35.1383046"
  },
  "errors": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
empresa
string
required

CNPJ da empresa para qual deseja consultar o crédito. Formato: apenas números (ex: 99999999999999)

Pattern: ^[0-9]{14}$
​
pessoa
string
required

CPF da pessoa para qual deseja consultar o crédito. Formato: apenas números (ex: 99999999999)

Pattern: ^[0-9]{11}$

Response

Crédito consultado com sucesso

​
sucesso
boolean

Indica se a operação foi executada com sucesso. true para sucesso, false para erro

Example:

true

​
data
object

Objeto contendo os dados do crédito consultado. Presente apenas quando sucesso = true

​
errors
string

Descrição detalhada do erro. Presente apenas quando sucesso = false