Company Search With Strings
This API allows you to search for a company based on the company name, customer name, and customer reference.
To use this API, you will need to provide your App ID and Secret Key in the header. In the body, you will need to specify the search query, customer name, and customer reference.
The API will return a list of companies that match the search query, along with their international number and country code.
TEST DATA
Query: Pharmy
POST
{{URL}}/identitypass/verification/global/company/search_with_string
Request Header
| Key | Description |
|---|---|
| app-id | Your App ID |
| x-api-key | Your Secret Key |
Request Body
| Key | Description |
|---|---|
| query | Query |
Sample Response
{
"status": true,
"response_code": "00",
"message": "Companies Retrieved Successfully",
"data": [
{
"id": 91111111,
"name": "rita(dr)",
"countryId": 24,
"occupation": null,
"nationality": null,
"birthYear": null,
"birthMonth": null,
"birthDate": null,
"address": "15, ABAYOI STREET, NAIROBI",
"countryOfResidence": "KENYA",
"honorific": null,
"number": null,
"isForeign": null,
"documentType": null,
"documentIssuedOn": null,
"documentIssuedBy": null,
"documentNumber": null,
"hideAddress": null,
"email": "",
"phone": null,
"hidden": null,
"countryCode": "ke",
"companies": [
{
"name": "LIFE SCIENCES KENYA LIMITED",
"shortName": null,
"brandName": null,
"countryCode": "ke",
"percentage": null,
"amount": null,
"appointedOn": null,
"resignedOn": null,
"role": {
"id": 60317,
"name": "Director",
"providerId": null,
"countryId": 24,
"translation": {
"cs": "Ředitel",
"de": "Direktor",
"en": "Director",
"es": "Director",
"fr": "Directeur",
"lt": "Direktorius",
"lv": "Direktors",
"nl": "Directeur",
"pl": "Dyrektor",
"ro": "Director",
"ru": "Директор",
"tr": "Müdür",
"uk": "Директор",
"zh": "负责人"
},
"isInactive": null,
"priority": 2
}
}
]
},
{
"id": 9000000,
"name": "Kwamboka Joy",
"countryId": 24,
"occupation": null,
"nationality": null,
"birthYear": null,
"birthMonth": null,
"birthDate": null,
"address": "BLK 5 FLT 22 RABIAT THOMPSON CRESCENT NAIROBI LAGOS",
"countryOfResidence": "KENYA",
"honorific": null,
"number": null,
"isForeign": null,
"documentType": null,
"documentIssuedOn": null,
"documentIssuedBy": null,
"documentNumber": null,
"hideAddress": null,
"email": "",
"phone": null,
"hidden": null,
"countryCode": "ke",
"companies": [
{
"name": "WOOD LTD",
"shortName": null,
"brandName": null,
"countryCode": "ng",
"percentage": null,
"amount": null,
"appointedOn": null,
"resignedOn": null,
"role": {
"id": 60000,
"name": "Director",
"providerId": null,
"countryId": 24,
"translation": {
"cs": "Ředitel",
"de": "Direktor",
"en": "Director",
"es": "Director",
"fr": "Directeur",
"lt": "Direktorius",
"lv": "Direktors",
"nl": "Directeur",
"pl": "Dyrektor",
"ro": "Director",
"ru": "Директор",
"tr": "Müdür",
"uk": "Директор",
"zh": "负责人"
},
"isInactive": null,
"priority": 2
}
},
{
"name": "TRIANGULAR ADVISORY LIMITED",
"shortName": null,
"brandName": null,
"countryCode": "ke",
"percentage": null,
"amount": null,
"appointedOn": null,
"resignedOn": null,
"role": {
"id": 60317,
"name": "Director",
"providerId": null,
"countryId": 24,
"translation": {
"cs": "Ředitel",
"de": "Direktor",
"en": "Director",
"es": "Director",
"fr": "Directeur",
"lt": "Direktorius",
"lv": "Direktors",
"nl": "Directeur",
"pl": "Dyrektor",
"ro": "Director",
"ru": "Директор",
"tr": "Müdür",
"uk": "Директор",
"zh": "负责人"
},
"isInactive": null,
"priority": 2
}
},
{
"name": "TRI AD LIMITED",
"shortName": null,
"brandName": null,
"countryCode": "ke",
"percentage": null,
"amount": null,
"appointedOn": null,
"resignedOn": null,
"role": {
"id": 60323,
"name": "Shareholder",
"providerId": null,
"countryId": 24,
"translation": {
"cs": "Akcionáři",
"de": "Aktionär",
"en": "Shareholder",
"es": "Accionista",
"fr": "Actionnaire",
"lt": "Akcininkas",
"lv": "Akcionārs",
"nl": "Aandeelhouder",
"pl": "Akcjonariusz",
"ro": "Acționar",
"ru": "Акционер",
"tr": "Hissedar",
"uk": "Акціонер",
"zh": "股东"
},
"isInactive": null,
"priority": 1
}
}
]
},
],
"verification": {
"status": "VERIFIED",
"reference": "1f113c-3560-422e-b7c9-b373446f"
},
"widget_info": {},
"session": {},
"endpoint_name": "Company Search by Person"
}
Response Description
| Response | Description |
|---|---|
| status | Indicates that the request was successful. |
| response_code | Represents the response code. |
| message | Provides a message indicating that the companies were retrieved successfully. |
| data | An array containing the retrieved company information. |
| name | The name of the company. |
| shortName | The short name of the company. |
| brandName | The brand name of the company. |
| internationalNumber | The international number or registration code of the company. |
| countryCode | The country code of the company. |
Updated 1 day ago