Organizations Lookup

POST

Lookup for a given business name or business number across international business registries.

The lookup will return a list of matching companies that you can then potentially query using the business profile query.

Each lookup result will have a organizationToken that you use to retrieve the specific company details using the profile or ownership function.

Note: This process will not save any details from the lookup results.

Headers

X-Frankie-CustomerIDstringRequired

Your Customer ID provided by FrankieOne

X-Frankie-CustomerChildIDstringOptional

Your Customer Child ID provided by FrankieOne

X-Frankie-ChannelstringOptional

Open string that can be used to define the “channel” the request comes in from. It can potentially be used in routing and risk calculations upon request. Default values that can be used are: api portal smartui Any alphanumeric string is supported though. Anything over 64 characters will be truncated.

Request

This endpoint expects an object.
regionobjectRequired
organizationNamestringOptional

The name of the organization that we are looking up for

organizationNumberobjectOptional

Response

OK

requestIdstring

The unique request ID for the API call made.

matchedOrganizationslist of objects

An array of organizations matching the provided lookup criteria

queryDetailsobject

Contains the criteria used to lookup for organizations.

Built with