BREAGEN Logo
Entity Management

Entity Search

The Entity Search service provides functionality to search for entities, retrieve search data, and perform reason searches across different jurisdictions.

Entity Search Operations

Resource URL/v1/entity-search/
Response FormatJSON
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Query Parameters

ParameterTypeRequiredDescription
session_idstringYesUnique session identifier
entity_namestringYesName of entity to search
entity_typestringYesType of entity to search for
client_idstringYesClient identifier
jurisdictionstringYesJurisdiction to search within

Example Request

curl -X 'GET' \
'https://api.braegen.ai/v1/entity-search/?session_id=sess_123&entity_name=Acme%20Corp&entity_type=company&client_id=client_456&jurisdiction=US' \
-H 'accept: application/json'

Example Response

{
	"success": true,
	"status": "200 OK",
	"data": [
		{
			"entity_id": "ENT-001",
			"entity_name": "Acme Corp",
			"entity_type": "company",
			"jurisdiction": "US",
			"match_score": 0.95,
			"registration_number": "REG123456"
		},
		{
			"entity_id": "ENT-002",
			"entity_name": "Acme Corporation",
			"entity_type": "company",
			"jurisdiction": "US",
			"match_score": 0.85,
			"registration_number": "REG789012"
		}
	]
}

Search Data GET /v1/entity-search/data

Resource URL/v1/entity-search/data
Response FormatJSON
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Query Parameters

ParameterTypeRequiredDescription
client_idstringYesClient identifier
request_idstringYesUnique request identifier

Example Request

curl -X 'GET' \
'https://api.braegen.ai/v1/entity-search/data?client_id=client_456&request_id=req_789' \
-H 'accept: application/json'

Example Response

{
	"success": true,
	"status": "200 OK",
	"data": {
		"request_id": "req_789",
		"search_timestamp": "2024-06-12T10:30:00Z",
		"entity_details": {
			"name": "Acme Corp",
			"registration_date": "2010-03-15",
			"status": "Active",
			"address": {
				"street": "123 Business Ave",
				"city": "Enterprise City",
				"state": "CA",
				"postal_code": "90210"
			}
		}
	}
}
Resource URL/v1/entity-search/reason_search
Response FormatJSON
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Query Parameters

ParameterTypeRequiredDescription
client_idstringYesClient identifier
pageintegerNoPage number for pagination
page_sizeintegerNoNumber of results per page

Example Request

curl -X 'GET' \
'https://api.braegen.ai/v1/entity-search/reason_search?client_id=client_456&page=1&page_size=10' \
-H 'accept: application/json'

Example Response

{
	"success": true,
	"status": "200 OK",
	"data": {
		"total_count": 25,
		"page": 1,
		"page_size": 10,
		"reasons": [
			{
				"reason_id": "RSN-001",
				"reason_type": "OWNERSHIP_CHANGE",
				"description": "Change in beneficial ownership",
				"date_recorded": "2024-06-12T10:30:00Z"
			},
			{
				"reason_id": "RSN-002",
				"reason_type": "STATUS_UPDATE",
				"description": "Entity status updated to inactive",
				"date_recorded": "2024-06-12T11:45:00Z"
			}
		]
	}
}

HTTP Response Codes

HTTP CodeMessage
200Success
400Bad Request
401Unauthorized
403Invalid Input
404Invalid or not found type

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 provided",
	"data": null
}

Authorization Error

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

On this page