Appearance
GET /api/v1/me/legal-entities/[id]
Retrieve details for a single legal entity by ID. The entity must have been consented by the user and the user must still be an active representative.
Endpoint
GET /api/v1/me/legal-entities/{id}Authentication
Requires a valid OAuth access token with the eprospera:entity.read scope.
Authorization: Bearer <access-token>Required Scopes
eprospera:entity.read
Path Parameters
| Parameter | Type | Description |
|---|---|---|
id | string (UUID) | The legal entity ID |
Example Request
bash
curl https://portal.eprospera.com/api/v1/me/legal-entities/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
-H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."Response
Success Response (200 OK)
Returns the legal entity details.
| Field | Type | Description |
|---|---|---|
data.id | string | Unique identifier for the legal entity |
data.optionId | string | Entity formation option (e.g., llc, for_profit_corp) |
data.type | string | Entity type (e.g., "Limited Liability Company") |
data.name | string | Legal name of the entity |
data.extension | string | Name extension (e.g., "LLC", "Inc.") |
data.nameStartsWithExtension | boolean | Whether the name starts with the extension |
data.formationDate | string | Original formation date (YYYY-MM-DD) |
data.principalOfficeAddress | object | Principal office address |
data.registrationDate | string | Date registered in Prospera |
data.dissolutionDate | string | null | Dissolution date, if applicable |
data.residentPermitNumber | string | null | Entity's Resident Permit Number |
Example Response
json
{
"data": {
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"optionId": "llc",
"type": "Limited Liability Company",
"name": "Acme Holdings",
"extension": "LLC",
"nameStartsWithExtension": false,
"formationDate": "2023-06-15",
"principalOfficeAddress": {
"line1": "Calle Principal 456",
"line2": null,
"city": "Roatan",
"state": "Islas de la Bahia",
"postalCode": "34101",
"country": "Honduras"
},
"registrationDate": "2023-06-15T14:30:00.000Z",
"dissolutionDate": null,
"residentPermitNumber": "80123456789012"
}
}404 Not Found
Returned when the entity doesn't exist, wasn't consented, or the user is no longer a representative.
json
{
"error": "Legal entity not found"
}Error Responses
401 Unauthorized - Missing Token
json
{
"error": "missing_token"
}401 Unauthorized - Invalid Token
json
{
"error": "invalid_token"
}401 Unauthorized - Insufficient Scopes
json
{
"error": "missing_scopes: eprospera:entity.read"
}500 Internal Server Error
json
{
"error": "Internal server error"
}Related Endpoints
- GET /api/v1/me/legal-entities - List all consented entities
- GET /api/v1/me/legal-entities/[id]/documents - Get entity documents