---
title: "Retrieve an account by ID"
method: GET
path: "/api/creditcontrol/accounts/{creditAccountId}"
tags: ["Account"]
---

# Retrieve an account by ID

`GET /api/creditcontrol/accounts/{creditAccountId}`

## Request

- Base URL: `https://apiexamples.vtexcommercestable.com.br`
- URL: `https://apiexamples.vtexcommercestable.com.br/api/creditcontrol/accounts/{creditAccountId}`
- Auth: one of:
  - API key in header `X-VTEX-API-AppKey` and API key in header `X-VTEX-API-AppToken`
  - API key in header `VtexIdclientAutCookie`

Retrieves a [customer credit account](https://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU) by the credit account identification.

## Permissions

Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:

| **Product** | **Category** | **Resource** |
| --------------- | ----------------- | ----------------- |
| Credit Control | Main | **Main Access** |
| Credit Control | Checking Accounts | **Read Checking Accounts** |

There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).

>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.

## Path parameters

- `creditAccountId` string, required

## Headers

- `Content-Type` string, required
- `Accept` string, required

## Response `200`

OK

- object
  - `id` string, required: Credit customer account identification.
  - `balance` number, required: Account balance value. If this number is negative, it means that the account has a debit instead of a credit to be used.
  - `document` string, required: Account owner document.
  - `status` string, required: Credit customer account status.
  - `documentType` string, required: Document type. Possible values: `CPF`, `CNPJ` or `Other`.
  - `creditLimit` number, required: Maximum credit amount on the account.
  - `updatedAt` string, required: Date of the last update made to the account.
  - `createdAt` string, required: Account creation date.
  - `description` string: This field is deprecated.
  - `availableCredit` number, required: Credit amount available on the account.
  - `preAuthorizedCredit` number, required: Credit value that can only be used by the account owner after the merchant releases a specific purchase transaction.
  - `email` string, required: Account owner email.
  - `tolerance` number, required: Account credit tolerance (in decimals). This value represents the increase in credit on an account. For example, a value of `0.30` indicates that the account owner can use up to 30% above the account's original maximum credit amount.
  - `availableBalance` number, required: Balance available for use on the account.

## Changes

- **2023-12-21** `0cfe5b381175`: 8 warning
  - the optional response header `Connection` removed for the status `200`
  - the optional response header `Content-Length` removed for the status `200`
  - the optional response header `Date` removed for the status `200`
  - the optional response header `Server` removed for the status `200`
  - …4 more
- **2023-11-24** `c8735f67eb83`: 3 breaking, 10 info
  - the response property `description` became optional for the status `200`
  - removed the required property `account` from the response with the `200` status
  - removed the required property `lastUpdate` from the response with the `200` status
  - added the required property `availableBalance` to the response with the `200` status
  - …9 more
- **2023-11-17** `1a0ba22582f0`: 1 info
  - media type `application/json; charset=utf-8` was changed to `application/json` for the response status `200`

[Operation history](https://skmtc.dev/vtex/apis/customer-credit-api/changes/api/creditcontrol/accounts/:creditAccountId/get.md)

---

[API](https://skmtc.dev/vtex/apis/customer-credit-api.md) - [All operations](https://skmtc.dev/vtex/apis/customer-credit-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vtex/apis/customer-credit-api/revisions/831ad1f05e7d?raw)