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}}/peleza/verification/global/company/search_with_string

Request Header

KeyDescription
app-idYour App ID
x-api-keyYour Secret Key

Request Body

KeyDescription
queryQuery

Sample Response

{
    "status": true,
    "response_code": "00",
    "message": "Companies Retrieved Successfully",
    "data": [
        {
            "name": "Pharmy Ventures",
            "shortName": null,
            "brandName": null,
            "internationalNumber": "BN-000000",
            "countryCode": "KES"
        }
    ]
}

Response Description

ResponseDescription
statusIndicates that the request was successful.
response_codeRepresents the response code.
messageProvides a message indicating that the companies were retrieved successfully.
dataAn array containing the retrieved company information.
nameThe name of the company.
shortNameThe short name of the company.
brandNameThe brand name of the company.
internationalNumberThe international number or registration code of the company.
countryCodeThe country code of the company.