BREAGEN Logo
Entity Management

Entity Page

The Entity Page service provides functionality to select and retrieve detailed entity information, including field data and company information, using various identifiers and request parameters.

Entity Page Operations

Select Entity GET /v1/entity-page/{entity_type}/{identifier}/{request_id}/select

Resource URL/v1/entity-page/{entity_type}/{identifier}/{request_id}/select
Response FormatJSON
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Path Parameters

ParameterTypeRequiredDescription
entity_typestringYesType of entity
identifierstringYesEntity identifier
request_idstringYesUnique request identifier

Query Parameters

ParameterTypeRequiredDescription
session_idstringYesSession identifier
client_idstringYesClient identifier
jurisdictionstringYesJurisdiction code

Example Request

curl -X 'GET' \
'https://api.braegen.ai/v1/entity-page/company/12345/req_789/select?session_id=sess_123&client_id=client_456&jurisdiction=US' \
-H 'accept: application/json'

Example Response

{
	"success": true,
	"status": "200 OK",
	"data": {
		"entity_id": "12345",
		"entity_type": "company",
		"selection_status": "success",
		"selected_data": {
			"name": "Acme Corp",
			"jurisdiction": "US",
			"status": "selected"
		}
	}
}

Select Data GET /v1/entity-page/{request_id}/select

Resource URL/v1/entity-page/{request_id}/select
Response FormatJSON
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Path Parameters

ParameterTypeRequiredDescription
request_idstringYesUnique request identifier

Query Parameters

ParameterTypeRequiredDescription
identifierstringYesEntity identifier

Example Request

curl -X 'GET' \
'https://api.braegen.ai/v1/entity-page/req_789/select?identifier=12345' \
-H 'accept: application/json'

Example Response

{
	"success": true,
	"status": "200 OK",
	"data": {
		"selection_details": {
			"identifier": "12345",
			"selected_timestamp": "2024-06-12T10:30:00Z",
			"status": "complete"
		}
	}
}

Get Entity Fields GET /v1/entity-page/{entity_type}/{identifier}/{request_id}

Resource URL/v1/entity-page/{entity_type}/{identifier}/{request_id}
Response FormatJSON
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Path Parameters

ParameterTypeRequiredDescription
entity_typestringYesType of entity
identifierstringYesEntity identifier
request_idstringYesUnique request identifier

Query Parameters

ParameterTypeRequiredDescription
session_idstringYesSession identifier
fieldstringYesField to retrieve
client_idstringYesClient identifier

Example Request

curl -X 'GET' \
'https://api.braegen.ai/v1/entity-page/company/12345/req_789?session_id=sess_123&field=ownership&client_id=client_456' \
-H 'accept: application/json'

Example Response

{
	"success": true,
	"status": "200 OK",
	"data": {
		"field_name": "ownership",
		"field_value": {
			"owners": [
				{
					"name": "John Doe",
					"percentage": 60,
					"type": "individual"
				},
				{
					"name": "Jane Smith",
					"percentage": 40,
					"type": "individual"
				}
			]
		}
	}
}

Get Field Data GET /v1/entity-page/{request_id}

Resource URL/v1/entity-page/{request_id}
Response FormatJSON
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Path Parameters

ParameterTypeRequiredDescription
request_idstringYesUnique request identifier

Query Parameters

ParameterTypeRequiredDescription
fieldstringYesField to retrieve
identifierstringYesEntity identifier

Example Request

curl -X 'GET' \
'https://api.braegen.ai/v1/entity-page/req_789?field=address&identifier=12345' \
-H 'accept: application/json'

Example Response

{
	"success": true,
	"status": "200 OK",
	"data": {
		"field": "address",
		"value": {
			"street": "123 Business Ave",
			"city": "Enterprise City",
			"state": "CA",
			"postal_code": "90210",
			"country": "US"
		}
	}
}

Get Company Info GET /v1/entity-page/{request_id}/company_info

Resource URL/v1/entity-page/{request_id}/company_info
Response FormatJSON
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Path Parameters

ParameterTypeRequiredDescription
request_idstringYesUnique request identifier

Query Parameters

ParameterTypeRequiredDescription
identifierstringYesEntity identifier
jurisdictionstringYesJurisdiction code
client_idstringYesClient identifier

Example Request

curl -X 'GET' \
'https://api.braegen.ai/v1/entity-page/req_789/company_info?identifier=12345&jurisdiction=US&client_id=client_456' \
-H 'accept: application/json'

Example Response

{
	"success": true,
	"status": "200 OK",
	"data": {
		"company_details": {
			"name": "Acme Corp",
			"registration_number": "REG123456",
			"incorporation_date": "2010-03-15",
			"status": "Active",
			"company_type": "Corporation",
			"jurisdiction": "US",
			"registered_address": {
				"street": "123 Business Ave",
				"city": "Enterprise City",
				"state": "CA",
				"postal_code": "90210"
			}
		}
	}
}

HTTP Response Codes

HTTP CodeMessage
200Success
400Bad Request
401Unauthorized
403Invalid Input
404Entity not found
422Validation Error

Common Error Responses

Entity Not Found

{
	"success": false,
	"status": "404 NOT_FOUND",
	"message": "Entity not found",
	"data": null
}

Invalid Parameters

{
	"success": false,
	"status": "400 BAD_REQUEST",
	"message": "Invalid entity type or identifier",
	"data": null
}

Authentication Error

{
	"success": false,
	"status": "401 UNAUTHORIZED",
	"message": "Invalid or missing authentication token",
	"data": null
}

Previous

Graph API Documentation

Next

Entity Search

On this page