> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.thepennyinc.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.thepennyinc.com/_mcp/server.

# Get your business entity

GET https://sandbox.api.thepennyinc.com/businesses/entity

Retrieve your business's default business entity -- the legal entity that owns accounts and cardholders you create. The entity's address, phone, email, and registration number are masked by default; set `reveal_sensitive` to true to include their real values.

Required permissions: `business_entity:read`.

Reference: https://docs.thepennyinc.com/banking/api-reference/business/entities/get-default

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Servers

- `https://sandbox.api.thepennyinc.com` (Sandbox — safe for testing, no real money movement., default)
- `https://live.api.thepennyinc.com` (Live — real businesses, real money movement.)

## Request

### Query parameters

- `reveal_sensitive` (boolean, optional, default: false) — Whether to include unmasked sensitive fields in the response. Defaults to false.

### Headers

- `X-Penny-As-Business` (string, optional, nullable) — Act on behalf of another business that has granted you access. Requires the `business:act_as` permission.

## Response

### 200

Your default business entity.

- `business_entity_id` (string, required) — Penny's unique identifier for this business entity.
- `business_id` (string, required) — The business this entity belongs to.
- `version` (integer, required) — A number that increases each time this business entity's details change. Use it to confirm you are looking at the latest information.
- `version_time` (datetime, required) — The date and time this business entity's details were last changed.
- `status` (enum, required) — The business entity's current lifecycle status.
  - Allowed values: `pending`, `active`, `deactivated`, `suspended`, `closed`
- `active` (boolean, required) — Whether this business entity is currently active.
- `closed` (boolean, required) — Whether this business entity has been closed.
- `legal_name` (string, required) — The business entity's full registered legal name.
- `dba_name` (string, required) — The name the business entity trades under, if different from its legal name.
- `registration_date` (date, required) — The date this business entity was legally registered.
- `address` (AddressResponse, required) — The business entity's registered physical address. On the client API, shown as masked placeholders unless the request is for a single business entity retrieved directly.
- `kyb_details` (KYBDetailsResponse, required) — The status of this business entity's identity verification.
- `website` (string, optional, nullable) — The business entity's website address, if it has one.
- `phone` (string, optional, nullable) — The business entity's contact phone number, if provided. On the client API, shown as a masked placeholder unless the request is for a single business entity retrieved directly.
- `email` (string, optional, nullable) — The business entity's primary contact email address, if provided. On the client API, shown as a masked placeholder unless the request is for a single business entity retrieved directly.
- `registration_number` (string, optional, nullable) — The business entity's official government registration number, if it has one on file. On the client API, shown as a masked placeholder unless the request is for a single business entity retrieved directly.

## Errors

### 400 Bad Request Error

The request was malformed: a required field is missing or a value has the wrong type or format.

- `type` (string, required) — The name of the exception that was raised.
- `message` (string, required) — A human-readable description of the error.
- `details` (map from string to any, optional, nullable) — Structured context about the error, if any.
- `trace_id` (string, optional, nullable) — Identifier for correlating this error with server-side logs.
- `errors` (list of map from string to any, optional, nullable) — Sub-errors that contributed to this failure, if any.

### 401 Unauthorized Error

Authentication failed.

- `type` (string, required) — The name of the exception that was raised.
- `message` (string, required) — A human-readable description of the error.
- `details` (map from string to any, optional, nullable) — Structured context about the error, if any.
- `trace_id` (string, optional, nullable) — Identifier for correlating this error with server-side logs.
- `errors` (list of map from string to any, optional, nullable) — Sub-errors that contributed to this failure, if any.

### 403 Forbidden Error

The caller does not have permission to perform this action.

- `type` (string, required) — The name of the exception that was raised.
- `message` (string, required) — A human-readable description of the error.
- `details` (map from string to any, optional, nullable) — Structured context about the error, if any.
- `trace_id` (string, optional, nullable) — Identifier for correlating this error with server-side logs.
- `errors` (list of map from string to any, optional, nullable) — Sub-errors that contributed to this failure, if any.

### 404 Not Found Error

The default business entity was not found.

- `type` (string, required) — The name of the exception that was raised.
- `message` (string, required) — A human-readable description of the error.
- `details` (map from string to any, optional, nullable) — Structured context about the error, if any.
- `trace_id` (string, optional, nullable) — Identifier for correlating this error with server-side logs.
- `errors` (list of map from string to any, optional, nullable) — Sub-errors that contributed to this failure, if any.

### 422 Unprocessable Entity Error

The request was well-formed but could not be processed because it breaks a business rule.

- `type` (string, required) — The name of the exception that was raised.
- `message` (string, required) — A human-readable description of the error.
- `details` (map from string to any, optional, nullable) — Structured context about the error, if any.
- `trace_id` (string, optional, nullable) — Identifier for correlating this error with server-side logs.
- `errors` (list of map from string to any, optional, nullable) — Sub-errors that contributed to this failure, if any.

### 429 Too Many Requests Error

Too many requests; retry after the Retry-After header.

- `type` (string, required) — The name of the exception that was raised.
- `message` (string, required) — A human-readable description of the error.
- `details` (map from string to any, optional, nullable) — Structured context about the error, if any.
- `trace_id` (string, optional, nullable) — Identifier for correlating this error with server-side logs.
- `errors` (list of map from string to any, optional, nullable) — Sub-errors that contributed to this failure, if any.

### 500 Internal Server Error

An unexpected error occurred.

- `type` (string, required) — The name of the exception that was raised.
- `message` (string, required) — A human-readable description of the error.
- `details` (map from string to any, optional, nullable) — Structured context about the error, if any.
- `trace_id` (string, optional, nullable) — Identifier for correlating this error with server-side logs.
- `errors` (list of map from string to any, optional, nullable) — Sub-errors that contributed to this failure, if any.

## Types

### AddressResponse

External API representation of a physical address. Country is normalized to ISO 3166-1 alpha-2. State/province is normalized to its subdivision code where applicable.

- `line_1` (string, required) — Primary address line.
- `city` (string, required) — City or locality.
- `zip_code` (string, required) — Postal or ZIP code.
- `country` (string, required) — Country in ISO 3166-1 alpha-2 format.
- `line_2` (string, optional, nullable) — Secondary address line.
- `state_or_province` (string, optional, nullable) — State or province code (if applicable).

### KYBDetailsResponse

The status of a business entity's identity verification (Know Your Business, or KYB) check, and the outcome once a decision has been made.

- `status` (enum, required) — Where this business entity is in the verification process: 'not_submitted' (verification has not started), 'pending' or 'in_progress' (under review), 'approved', or 'declined'.
  - Allowed values: `not_submitted`, `pending`, `in_progress`, `approved`, `declined`
- `rejection_reason` (string, optional, nullable) — Why verification was rejected. Absent unless status is 'declined'.

## Examples

**Response**

```json
{
  "business_entity_id": "business_entity_01937c9d-3a1e-72b0-8881-3a1e2b088159",
  "business_id": "business_01937b95-484e-75af-8c68-484e5afc68d3",
  "version": 1,
  "version_time": "2024-01-15T10:30:00Z",
  "status": "pending",
  "active": true,
  "closed": false,
  "legal_name": "Acme Corporation Pty Ltd",
  "dba_name": "Acme",
  "registration_date": "2020-01-15",
  "address": {
    "line_1": "123 Main Street",
    "city": "New York",
    "zip_code": "10001",
    "country": "US",
    "line_2": "Suite 200",
    "state_or_province": "NY"
  },
  "kyb_details": {
    "status": "not_submitted",
    "rejection_reason": "string"
  },
  "website": "https://www.acme.example",
  "phone": "+15551234567",
  "email": "contact@acme.example",
  "registration_number": "ABN 12 345 678 901"
}
```

**SDK Code**

```python
import requests

url = "https://sandbox.api.thepennyinc.com/businesses/entity"

headers = {
    "X-Penny-As-Business": "business_01a083e2-82ed-7a5c-9d1e-3b6f0c2a4d71",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://sandbox.api.thepennyinc.com/businesses/entity';
const options = {
  method: 'GET',
  headers: {
    'X-Penny-As-Business': 'business_01a083e2-82ed-7a5c-9d1e-3b6f0c2a4d71',
    Authorization: 'Bearer <token>'
  }
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.api.thepennyinc.com/businesses/entity"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Penny-As-Business", "business_01a083e2-82ed-7a5c-9d1e-3b6f0c2a4d71")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://sandbox.api.thepennyinc.com/businesses/entity")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Penny-As-Business"] = 'business_01a083e2-82ed-7a5c-9d1e-3b6f0c2a4d71'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://sandbox.api.thepennyinc.com/businesses/entity")
  .header("X-Penny-As-Business", "business_01a083e2-82ed-7a5c-9d1e-3b6f0c2a4d71")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://sandbox.api.thepennyinc.com/businesses/entity', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'X-Penny-As-Business' => 'business_01a083e2-82ed-7a5c-9d1e-3b6f0c2a4d71',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://sandbox.api.thepennyinc.com/businesses/entity");
var request = new RestRequest(Method.GET);
request.AddHeader("X-Penny-As-Business", "business_01a083e2-82ed-7a5c-9d1e-3b6f0c2a4d71");
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "X-Penny-As-Business": "business_01a083e2-82ed-7a5c-9d1e-3b6f0c2a4d71",
  "Authorization": "Bearer <token>"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://sandbox.api.thepennyinc.com/businesses/entity")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```