Feel free to reach techsupport@surepass.io for any technical support or guidance.
Authorization
header as Bearer TOKEN
.https://sandbox.surepass.io
https://kyc-api.surepass.io
Header | Required | Description |
---|---|---|
Authorization | Yes | Bearer token authentication using JWT |
Content-Type | Yes | application/json |
Parameter | Type | Required | Description |
---|---|---|---|
company | String | Yes | The name of the company to search for |
state | String | Yes | The state where the company is registered |
exact_match | Boolean | No | When set to true, returns only exact matches of the company name (default: false) |
search_size | String | No | Search size |
fuzziness | Boolean | No | Fuzziness |
auto_complete | Boolean | No | Auto Complete |
{
"company": "ABC PRIVATE LIMITED",
"state": "Delhi",
"exact_match": true
}
Parameter | Type | Description |
---|---|---|
data | Object | Contains the search results and metadata |
data.client_id | String | Unique identifier for the API request |
data.search_company_name | String | The company name that was searched |
data.search_size | Number | Maximum number of search results to return |
data.search_state | String | The state that was searched |
data.exact_match | Boolean | Whether exact matching was used |
data.hits | Number | Number of companies found matching the criteria |
data.search_data | Array | List of companies matching the search criteria |
data.search_data[].tan | String | Tax Deduction and Collection Account Number |
data.search_data[].company_name | String | Name of the company |
status_code | Number | HTTP status code of the response |
success | Boolean | Indicates if the API call was successful |
message | String | Human-readable status message |
message_code | String | Machine-readable status code |
{
"data": {
"client_id": "tan_company_search_MrZzXqGKYgZoewbEymGS",
"search_company_name": "ABC PRIVATE LIMITED",
"search_size": 10,
"search_state": "DELHI",
"exact_match": true,
"hits": 1,
"search_data": [
{
"tan": "DELS71234E",
"company_name": "ABC PRIVATE LIMITED"
}
]
},
"status_code": 200,
"success": true,
"message": "Success",
"message_code": "success"
}
{
"status_code": 400,
"success": false,
"message": "Invalid input parameters",
"message_code": "invalid_input"
}
curl --location --request POST 'https://kyc-api.surepass.app/api/v1/tan/company-search' \
--header 'Content-Type: application/json' \
--data-raw '{
"company": "ABC PRIVATE LIMITED",
"state": "Delhi",
"exact_match": true
}'
{
"data": {
"client_id": "tan_company_search_MrZzXqGKYgZoewbEymGS",
"search_company_name": "ABC PRIVATE LIMITED",
"search_size": 10,
"search_state": "DELHI",
"exact_match": true,
"hits": 1,
"search_data": [
{
"tan": "DELS71234E",
"company_name": "ABC PRIVATE LIMITED"
}
]
},
"status_code": 200,
"success": true,
"message": "Success",
"message_code": "success"
}