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
Search Entities GET /v1/entity-search/
| Resource URL | /v1/entity-search/ |
|---|---|
| Response Format | JSON |
| Requires Authentication | Yes |
| Rate Limited | Yes |
| HTTPS | Yes |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| session_id | string | Yes | Unique session identifier |
| entity_name | string | Yes | Name of entity to search |
| entity_type | string | Yes | Type of entity to search for |
| client_id | string | Yes | Client identifier |
| jurisdiction | string | Yes | Jurisdiction to search within |
Example Request
Example Response
Search Data GET /v1/entity-search/data
| Resource URL | /v1/entity-search/data |
|---|---|
| Response Format | JSON |
| Requires Authentication | Yes |
| Rate Limited | Yes |
| HTTPS | Yes |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| client_id | string | Yes | Client identifier |
| request_id | string | Yes | Unique request identifier |
Example Request
Example Response
Reason Search GET /v1/entity-search/reason_search
| Resource URL | /v1/entity-search/reason_search |
|---|---|
| Response Format | JSON |
| Requires Authentication | Yes |
| Rate Limited | Yes |
| HTTPS | Yes |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| client_id | string | Yes | Client identifier |
| page | integer | No | Page number for pagination |
| page_size | integer | No | Number of results per page |
Example Request
Example Response
HTTP Response Codes
| HTTP Code | Message |
|---|---|
| 200 | Success |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Invalid Input |
| 404 | Invalid or not found type |