Basic Company Search 🔎
Overview
Our Basic company search allows users to find companies based on fundamental criteria such as company name or registration number. It typically involves using straightforward search interfaces provided by various platforms or databases. Users can input basic keywords or parameters related to the company they are looking for, and the search tool will return relevant results matching those criteria.
Basic company search is ideal for quickly finding specific companies or exploring a general list of companies within a particular category or region. It is commonly used by individuals or businesses seeking basic information about companies.
Important!
Before you proceed, ensure you review the prerequisites for integrating to our APIs for a more detailed guide.
API Endpoint
https://api.verified.africa/sfx-verify/v3/id-service/
Headers
Our service accepts headers for authentication. See below the headers to pass to the API
| Header | Type | Description |
|---|---|---|
| userId | String | This is your user id retrieved from the portal. Check the getting started article to understand how to retrieve your userId |
| apiKey | String | This is your apikey retrieved from the portal. Check the getting started article to understand how to retrieve your apiKey |
Request
| Request Parameter | Status | Description | Test Data |
|---|---|---|---|
| verificationType | Required | This field is used to identify the service being called. Ensure to use the value provided exactly as provided | BASIC-COMPANY-SEARCH |
| countryCode | Optional | The countryCode is passed in this field | NG |
| query | Required | The rcNumber is passed in this field | RC111111 |
| isConsent | Required | The customer must consent to the verification data policy | true |
| limit | Optional | This limits how many search results that can be displayed | 10 |
{
"verificationType": "BASIC-COMPANY-SEARCH",
"countryCode": "NG",
"query": "RC111111",
"isConsent": true,
"limit": "10"
}
Response
| Response Parameter | Type | Description |
|---|---|---|
| responseCode | String | Please reference Response Codes page for details on all possible responses |
| description | String | This is a description of the response received. |
| verificationType | String | The same verificationType passed in request will be returned here |
| verificationStatus | String | This field lets you know if the identity verification was successful. Options are: VERIFIED: This means that the query is valid. NOT VERIFIED This means that the query is invalid PENDING This status means that the verification could not be completed. Refer to the responseCode for the specific failure reason |
| transactionStatus | String | This indicates the wallet debit status. The options are successful or failed. |
| transactionReference | String | If you supplied a transactionReference, the same will be returned here. Else, we would generate a reference and return that to you in this field. |
| transactionDate | String | Date the transaction was done |
| response | Json | This is a Json containing all the actual Company data tied to that query as retrieved from the service provider. |
{
"responseCode": "00",
"description": "Successful",
"verificationType": "BASIC-COMPANY-SEARCH",
"verificationStatus": "VERIFIED",
"transactionStatus": "SUCCESSFUL",
"transactionReference": "1630321373727-SFSKPT9P-1708082594706-a371eb4e-debf-4f4b-a694-7f70bd8eac2a",
"transactionDate": "1708082597039",
"searchParameter": null,
"callBackUrl": null,
"livenessScore": 0.0,
"paymentRef": null,
"response": {
"success": true,
"statusCode": 200,
"message": "success",
"data": [
{
"name": "Sam Ventures",
"companyNumber": "RC333333",
"countryCode": "CA-FD",
"countryName": "Canada"
},
{
"name": "JOHN DOE ONLINE SERVICES LTD",
"companyNumber": "RC222222",
"countryCode": "NG",
"countryName": "Nigeria"
},
{
"name": "YJ.COM, INC.",
"companyNumber": "RC111111",
"countryCode": "US-CA",
"countryName": "United States Of America (USA)"
}
],
"links": []
},
"faceMatch": null,
"licenseSessionId": null,
"remainingLicenseSessionRound": null
}
Updated 6 months ago