#### **Overview**
The `SearchCompany V5` API enables users to perform a flexible search for companies in supported business registers based on partial or full company details. This service is ideal for initial discovery, verifying multiple entities, or narrowing down potential matches for a company.
---
#### **API Endpoint**
`POST /core/api/sessions/asia-verify/companies/search`
**Base URL**:
`https://api.zignsec.com`
---
#### **Request Format**
**Headers**:
- `Content-Type`: `application/json`
- `Authorization`: `Bearer <API_KEY>`
**Request example**:
``` bash
curl --location 'https://test-gateway.zignsec.com/core/api/sessions/asia-verify/companies/search' \
--header 'accept: application/json' \
--header 'authorization: Your Subscription Key' \
--header 'Content-Type: application/json' \
--header 'x-csrf-token: SSFwPgE6XxQzJWUlVSxCEE8yShY-PQAezx2Zbp5lAOVVcuog8E-GlWoS' \
--data '{
"metadata": {
"country_code": "CHN",
"keyword": "阿里巴巴（中国）"
},
"relay_state": "my-internal-id",
"webhook": "https://webhook.site"
}'
```
**Parameters**:
|Parameter|Type|Required|Description|
|---|---|---|---|
|`countryCode`|string|Yes|Two-letter ISO country code. Example: SE for Sweden.|
|`searchTerm`|string|Yes|The search keyword, such as part of the company name or number.|
|`maxResults`|integer|No|Maximum number of results to return. Default is `10`.|
---
#### **Response Format**
**Success Response**:
```json
{
"status": "Success",
"data": [
{
"companyName": "Example AB",
"registrationNumber": "5561234567",
"status": "Active",
"address":
{
"street": "Example Street 1",
"postalCode": "12345",
"city": "Stockholm",
"country": "SE"
},
"dateOfIncorporation": "2000-01-01"
},
{
"companyName": "Example Technologies AB",
"registrationNumber": "5569876543",
"status": "Active",
"address":
{
"street": "Tech Park 5",
"postalCode": "54321",
"city": "Gothenburg",
"country": "SE"
},
"dateOfIncorporation": "2015-05-10"
}
]
}
```
**Response Fields**:
|Field|Type|Description|
|---|---|---|
|`companyName`|string|The official name of the company.|
|`registrationNumber`|string|The unique registration number of the company.|
|`status`|string|Operational status of the company (e.g., Active, Inactive).|
|`address`|object|The registered address of the company.|
|`dateOfIncorporation`|string|The incorporation date of the company in YYYY-MM-DD format.|
---
#### **Error Responses**
|HTTP Code|Error Message|Description|
|---|---|---|
|`400`|`Invalid Request`|Missing or invalid input parameters.|
|`401`|`Unauthorized`|Missing or invalid API key.|
|`404`|`No Matches Found`|No companies matched the search term or criteria.|
|`500`|`Internal Server Error`|An unexpected error occurred on the server.|
---
#### **Examples**
**Request Example**:
```json
{
"countryCode": "NO",
"searchTerm": "Tech",
"maxResults": 5
}
```
**Success Response Example**:
```json
{
"status": "Success",
"data": [
{
"companyName": "Tech Solutions AS",
"registrationNumber": "987654321",
"status": "Active",
"address":
{
"street": "Main Road 12",
"postalCode": "56789",
"city": "Oslo",
"country": "NO"
},
"dateOfIncorporation": "2010-04-15"
}
]
}
```
**Error Response Example**:
```json
{
"status": "Error",
"errorCode": "404",
"message": "No Matches Found"
}
```
---
#### **Notes**
- The `searchTerm` can include partial names or numbers for broader searches.
- Use `maxResults` to limit the response size and improve performance for large datasets.
- Ensure the `countryCode` corresponds to the region where the search is being conducted.
- For enhanced accuracy, provide more specific `searchTerm` values.