Global Business Advanced - Search Entity by ID

Overview & Purpose

This API allows users to retrieve detailed information about a company or business entity.

By providing essential details such as country, state, and entity ID, users can obtain comprehensive data including the company's name, address, status, financial summary, officers, filings, industry codes, and more.

This information can be valuable for various business and regulatory purposes.

API Details

curl --request POST \
  --url https://preproduction.signzy.tech/api/v2/patrons/..your-patron-id../globalbusinessesv2 \
  --header 'Authorization: <Access-Token>' \
  --header 'content-type: application/json' \
  --data '{
    "task": "fetchEntitybyId",
    "essentials": {
        "country": "...country...",
        "state": "...state...",
        "entityId": "...entityId..."
    }
}'

API Input

Input Parameters

PARAMETERS	DESCRIPTION	TYPE	VALUE (COMPULSORY OR OPTIONAL)
entityId	Business Number of the company to be searched	String	COMPULSORY
country	Country Code of the country	String	COMPULSORY
state	State Code of the company	String	CONDITIONAL

The Supported Country Codes are listed below

COUNTRY CODE	COUNTRY NAME
AE	United Arab Emirates
AL	Albania
AU	Australia
AW	Aruba
BB	Barbados
BD	Bangladesh
BE	Belgium
BG	Bulgaria
BH	Bahrain
BL	Saint Barthélemy
BM	Bermuda
BO	Bolivia
BR	Brazil
BS	Bahamas
BY	Belarus
BZ	Belize
CA	Canada
CH	Switzerland
CW	Curacao
CY	Cyprus
CZ	Czech Republic
DE	Germany
DK	Denmark
DO	Dominican Republic
ES	Spain
FI	Finland
FR	France
FR	Réunion
GB	United Kingdom
GF	French Guiana
GG	Guernsey
GI	Gibraltar
GL	Greenland
GP	Guadeloupe
GR	Greece
HK	Hong Kong
HR	Croatia
IE	Ireland
IL	Israel
IM	Isle of Man
IN	India
IR	Iran
IS	Iceland
JE	Jersey
JM	Jamaica
JP	Japan
KH	Cambodia
LI	Liechtenstein
LU	Luxembourg
LV	Latvia
MD	Moldova
ME	Montenegro
MF	Saint Martin
MM	Myanmar
MQ	Martinique
MT	Malta
MU	Mauritius
MX	Mexico
MY	Malaysia
NL	Netherlands
NO	Norway
NZ	New Zealand
PA	Panama
PK	Pakistan
PL	Poland
PM	Saint Pierre and Miquelon
PR	Puerto Rico
PT	Portugal
RO	Romania
RW	Rwanda
SE	Sweden
SG	Singapore
SI	Slovenia
SK	Slovakia
TH	Thailand
TJ	Tajikistan
TN	Tunisia
TO	Tonga
TZ	Tanzania
UA	Ukraine
UG	Uganda
US	United States of America
VN	Viet Nam
VU	Vanuatu
YT	Mayotte
ZA	South Africa

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	District of Columbia
DE	Delaware
FL	Florida
GA	Georgia
HI	Hawaii
IA	Iowa
ID	Idaho
IN	Indiana
KS	Kansas
KY	Kentucky
LA	Louisiana
MA	Massachusetts
MD	Maryland
ME	Maine
MN	Minnesota
MO	Missouri
MS	Mississippi
MT	Montana
NC	North Carolina
ND	North Dakota
NE	Nebraska
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
TN	Tennessee
TX	Texas
UT	Utah
VA	Virginia
VT	Vermont
WA	Washington
WI	Wisconsin
WV	West Virginia
WY	Wyoming

The Supported State Codes for CA are listed below

STATE CODE	STATE NAME
NB	New Brunswick
NL	Newfoundland and Labrador
NS	Nova Scotia
PE	Prince Edward Island
QC	Quebec

The Supported State Codes for AE are listed below

STATE CODE	STATE NAME
AZ	Abu Dhabi (UAE)
DU	Dubai (UAE)

The Supported State Codes for FR are listed below

STATE CODE	STATE NAME
RE	Reunion

API Output

Sucess Response & Mapping

{
    "result": {
        "company": {
            "companyName": "...companyName...",
            "businessId": "...businessId...",
            "country": "...country...",
            "state": "...state...",
            "companyAddressDetails": "...companyAddressDetails...",
            "companyAddress": {
                "companyStreetAddress": "...companyStreetAddress...",
                "companyLocality": "...companyLocality...",
                "companyRegion": "...companyRegion...",
                "companyPostalCode": "...companyPostalCode...",
                "companyCountry": "...companyCountry..."
            },
            "currentCompanyStatus": "...currentCompanyStatus...",
            "incorporationDate": "...incorporationDate...",
            "isInactive": "...isInactive...",
            "dissolutionDate": "...dissolutionDate...",
            "companyType": "...companyType...",
            "registryUrl": "...registryUrl...",
            "numberOfEmployees": "...numberOfEmployees...",
            "previousNames": [
                {
                    "companyPreviousName": "...companyPreviousName...",
                    "startDate": "...startDate...",
                    "endDate": "...endDate..."
                }
            ],
            "alternateEntities": [
                {
                    "alternateEntityCompanyName": "...alternateEntityCompanyName...",
                    "alternateEntityCountry": "...alternateEntityCountry...",
                    "alternateEntityState": "...alternateEntityState...",
                    "alternateEntityBusinessId": "...alternateEntityBusinessId..."
                }
            ],
            "previousEntities": [
                {
                    "previousEntityCompanyName": "...previousEntityCompanyName...",
                    "previousEntityCountry": "...previousEntityCountry...",
                    "previousEntityState": "...previousEntityState...",
                    "previousEntityBusinessId": "...previousEntityBusinessId..."
                }
            ],
            "subsequentEntities": [
                {
                    "subsequentEntityCompanyName": "...subsequentEntityCompanyName...",
                    "subsequentEntityCountry": "...subsequentEntityCountry...",
                    "subsequentEntityState": "...subsequentEntityState...",
                    "subsequentEntityBusinessId": "...subsequentEntityBusinessId..."
                }
            ],
            "companyIdentifiers": [
                {
                    "uid": "...uid...",
                    "identifierSystemCode": "...identifierSystemCode...",
                    "identifierSystemName": "...identifierSystemName..."
                }
            ],
            "companyFinancialSummary": {
                "profit": "...profit...",
                "revenue": "...revenue...",
                "cashInBank": "...cashInBank...",
                "assets": [...assets...],
                "currentLiabilities": "...currentLiabilities...",
                "accountsDate": "...accountsDate...",
                "fixedAssets": "...fixedAssets...",
                "accountsType": "...accountsType...",
                "currency": "...currency..."
            },
            "controllingEntity": {
                "companyName": "...companyName...",
                "companyCountry": "...companyCountry...",
                "companyState": "...companyState...",
                "companyBusinessId": "...companyBusinessId..."
            },
            "ultimateBeneficialOwners": [
                {
                    "name": "...name..."
                }
            ],
            "homeCompany": {
                "homeCompanyName": "...homeCompanyName...",
                "homeCompanyCountry": "...homeCompanyCountry...",
                "homeCompanyState": "...homeCompanyState...",
                "homeCompanyBusinessId": "...homeCompanyBusinessId..."
            },
            "companyBranch": "...companyBranch...",
            "companyBranchStatus": "...companyBranchStatus...",
            "companyOfficers": [
                {
                    "officerId": "...officerId...",
                    "officerName": "...officerName...",
                    "officerPosition": "...officerPosition...",
                    "officerUid": "...officerUid...",
                    "officerStartDate": "...officerStartDate...",
                    "officerEndDate": "...officerEndDate...",
                    "officerOccupation": "...officerOccupation...",
                    "officerIsInActive": "...officerIsInActive...",
                    "officerCurrentStatus": "...officerCurrentStatus...",
                    "officerAddress": "...officerAddress...",
                    "officerNationality": "...officerNationality...",
                    "officerDob": "...officerDob..."
                }
            ],
            "corporateGroupings": [
                {
                    "companyGroupingName": "...companyGroupingName..."
                }
            ],
            "dataSource": "...dataSource...",
            "dataRetrievalDate": "...dataRetrievalDate...",
            "filings": [
                {
                    "filingId": "...filingId...",
                    "filingTitle": "...filingTitle...",
                    "filingDescription": "...filingDescription...",
                    "filingUid": "...filingUid...",
                    "filingCode": "...filingCode...",
                    "filingName": "...filingName...",
                    "filingDate": "...filingDate..."
                }
            ],
            "industryCodes": [
                {
                    "industryCodeDescription": "...industryCodeDescription...",
                    "industryCodeScheme": "...industryCodeScheme..."
                }
            ]
        }
    }
}

Output Parameters

Field Name	Data Type	Description
result	Object	The root object containing company information.
company	Object	Information about the company.
companyName	String	The name of the company.
businessId	String	The business ID or registration number of the company.
country	String	The country where the company is located.
state	String	The state or region where the company is located.
companyAddressDetails	String	Details about the company's address.
companyAddress	Object	The address of the company.
currentCompanyStatus	String	The current status of the company.
incorporationDate	String	The date of incorporation of the company.
isInactive	String	Indicates if the company is inactive.
dissolutionDate	String	The date of dissolution of the company.
companyType	String	The type or category of the company.
registryUrl	String	URL to access the company's registry information.
numberOfEmployees	String	The number of employees in the company.
previousNames	Array	An array of previous names associated with the company.
alternateEntities	Array	An array of alternate entities related to the company.
previousEntities	Array	An array of previous entities related to the company.
subsequentEntities	Array	An array of subsequent entities related to the company.
companyIdentifiers	Array	An array of identifiers associated with the company.
companyFinancialSummary	Object	Financial summary information about the company.
controllingEntity	Object	Information about the controlling entity of the company.
ultimateBeneficialOwners	Array	An array of ultimate beneficial owners of the company.
homeCompany	Object	Information about the home company.
companyBranch	String	Indicates if the company is a branch.
companyBranchStatus	String	The status of the company branch.
companyOfficers	Array	An array of officers associated with the company.
corporateGroupings	Array	An array of corporate groupings the company belongs to.
dataSource	String	The source of the company data.
dataRetrievalDate	String	The date when the data was retrieved.
filings	Array	An array of filings related to the company.
industryCodes	Array	An array of industry codes associated with the company.

Error Code Response & Mapping

{
  "error": {
    "statusCode": 409,
    "name": "error",
    "message": "Error in getting data from upstream",
    "status": 409
  }
}

Field Name	Data Type	Description
error	Object	The root object containing error details.
statusCode	Number	The HTTP status code indicating the error (409).
name	String	The name or type of the error ("error").
message	String	A descriptive error message explaining the issue ("Error in getting data from upstream").
status	Number	An additional status code providing more information about the error (409).

Getting help

Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.

You can reach out to us at [email protected]. We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.

We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!