Get your business 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.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Headers
X-Penny-As-Business
Act on behalf of another business that has granted you access. Requires the business:act_as permission.
Query parameters
reveal_sensitive
Whether to include unmasked sensitive fields in the response. Defaults to false.
Response
Your default business entity.
business_entity_id
Penny's unique identifier for this business entity.
business_id
The business this entity belongs to.
version
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
The date and time this business entity's details were last changed.
status
The business entity's current lifecycle status.
Allowed values:
active
Whether this business entity is currently active.
closed
Whether this business entity has been closed.
legal_name
The business entity's full registered legal name.
dba_name
The name the business entity trades under, if different from its legal name.
registration_date
The date this business entity was legally registered.
address
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
The status of this business entity's identity verification.
website
The business entity's website address, if it has one.
phone
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
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
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
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error