One entity: who it is, what it holds and how far it is closed
GET
/v1/entities/{entity_id}
const url = 'https://example.com/v1/entities/example';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/v1/entities/exampleThe entity itself, in the same shape GET /v1/entities lists.
This is where every entity response’s links.self points. It is built by the same code as the listing’s
items, so the two cannot disagree about what an entity is.
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”entity_id
required
Entity Id
The entity this path is relative to
string
The entity this path is relative to
Responses
Section titled “Responses”Successful Response
Media typeapplication/json
EntitySummary
object
entity_id
required
Entity Id
string
legal_name
required
Legal Name
string
legal_form
required
Legal Form
string
country
required
Country
string
base_currency
required
Base Currency
string
commodities
required
Commodities
Array<string>
lock_version
required
Lock Version
integer
live_close_eligible
required
Live Close Eligible
boolean
links
required
Links
object
key
additional properties
string
Example generated
{ "entity_id": "example", "legal_name": "example", "legal_form": "example", "country": "example", "base_currency": "example", "commodities": [ "example" ], "lock_through": "example", "lock_version": 1, "lock_close_id": "example", "live_close_eligible": true, "links": { "additionalProperty": "example" }}Bad Request
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Unauthorized
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Forbidden
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Not Found
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Conflict
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Precondition Failed
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Unprocessable Content
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Internal Server Error
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Service Unavailable
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}