Live Search By Name
Introduction
This API allows patrons to fetch information about global businesses based on certain parameters such as country, state, and entity name.
Sample CURL
curl --request POST \
--url https://signzy.tech/api/v2/patrons/..your-patron-id../globalbusinesses \
--header 'Accept: */*' \
--header 'Accept-Language: en-US,en;q=0.8' \
--header 'Authorization: <Access-Token>' \
--header 'content-type: application/json' \
--data '{"task":"fetchbyName","essentials":{"country":"...country...","state":"...state...","entityName":"...entityName..."}}'Parameter | Type | Description |
|---|---|---|
url | string | The endpoint URL for the API request. |
Accept | string | The format of the response that is expected from the server. |
Accept-Language | string | The preferred language for the response. |
Authorization | string | The access token required to authenticate the user making the request. |
content-type | string | The format of the request payload being sent to the server. |
task | string | The type of request to be made to the API. In this case, it is "fetchbyName". |
country | string | The name of the country where the business is located. |
state | string | The name of the state where the business is located. |
entityName | string | The name of the business entity that is being searched for. |
The Supported Country Codes are listed below
COUNTRY CODE | COUNTRY NAME |
|---|---|
AT | Austria |
AU | Australia |
BE | Belgium |
BG | Bulgaria |
BY | Belarus |
CA | Canada |
CH | Switzerland |
CN | China |
CY | Cyprus |
CZ | Czech Republic |
DE | Germany |
DK | Denmark |
EE | Estonia |
ES | Spain |
FI | Finland |
FR | France |
GG | Guernsey |
GI | Gibraltar |
GL | Greenland |
GR | Greece |
HK | Hongkong |
HR | Croatia |
HU | Hungary |
ID | Indonesia |
IE | Ireland |
IN | India |
IT | Italy |
JE | Jersey |
JP | Japan |
KG | Kyrgyzstan |
KH | Cambodia |
LT | Lithuania |
LU | Luxembourg |
LV | Latvia |
ME | Montenegro |
MK | Macedonia |
MT | Malta |
NL | Netherlands |
NO | Norway |
NZ | New Zealand |
PL | Poland |
RO | Romania |
RS | Serbia |
RU | Russia |
SE | Sweden |
SG | Singapore |
SI | Slovenia |
SK | Slovakia |
TW | Taiwan |
UA | Ukraine |
UK | United Kingdom |
US | United States of America |
XK | Kosovo |
The Supported State Codes for US are listed below
STATE CODE | STATE NAME |
|---|---|
AK | Alaska |
AL | Alabama |
AR | Arkansas |
AZ | Arizona |
CA | California |
CO | Colorado |
CT | Connecticut |
DC | Washington DC |
DE | Delaware |
FL | Florida |
GA | Georgia |
HI | Hawaii |
IA | Iowa |
ID | Idaho |
IL | Illinois |
IN | Indiana |
KS | Kansas |
KY | Kentucky |
LA | Louisiana |
MA | Massachusetts |
MD | Maryland |
ME | Maine |
MI | Michigan |
MN | Minnesota |
MO | Missouri |
MS | Mississippi |
MT | Montana |
NC | North Carolina |
ND | North Dakota |
NH | New Hampshire |
NJ | New Jersey |
NM | New Mexico |
NV | Nevada |
NY | New York |
OH | Ohio |
OK | Oklahoma |
OR | Oregon |
PA | Pennsylvania |
RI | Rhode Island |
SC | South Carolina |
SD | South Dakota |
TX | Texas |
UT | Utah |
VA | Virginia |
WA | Washington |
WI | Wisconsin |
WV | West Virginia |
WY | Wyoming |
Sample API Response
{
"result": [
{
"entityName": "..entityName..",
"entityId": "..entityId..",
}
]
}Parameter | Description |
|---|---|
entityName | Name of the entity |
entityId | Unique identifier of the entity returned |