KYC API EndpointsBusiness

(International) Search for a business from any country.

Search for a given business name or business number across international business registers. The search will return a list of matching companies that you can then potentially query using the international profile query (see below). Each search result will have a CompanyCode that you use to retrieve the specific company details using the profile function. * Note:* This process will *not* save any details from the search results.

Authentication

api_keystring
API Key authentication via header

Headers

X-Frankie-CustomerIDstringRequiredformat: "uuid"
Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time.
X-Frankie-CustomerChildIDstringOptionalformat: "uuid"
If, as a FrankieOne Customer, you are acting on behalf of your own customers, then you can populate this field with a FrankieOne-assigned ID. Note: If using a CustomerChildID, you will also need a separate api_key for each child. Any documents, checks, entities that are created when this field has been populated will now be tied to this CustomerID + CustomerChildID combination. Just as Customers cannot see data created by other Customers, so too a Customer's Children will not be able to see each other's data. A Customer can see the documents/entities and checks of all their Children.
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

The country, name or business number of the organisation to be queried.
countrystringRequired
The ISO 3166-1 alpha2 country code of country registry you wish to search. This is consistent for all countries except for: - The United States which requires the state registry to query as well. - As an example, for a Delaware query, the country code would be "US-DE". - A Texas query would use "US-TX" - Canada, which also requires you to supply a territory code too. - A Yukon query would use CA-YU, Manitoba would use CA-MB - You can do an all jurisdiction search with CA-ALL See details here: https://docs.frankieone.com/docs/country-codes-for-international-business-queries
organisation_namestringOptional
Name or name fragment you wish to search for. Note: The less you supply, the more, but less relevant results will be returned. CRITICAL NOTE: This is *NOT* to be used as a progressive search function. You must supply at least one of organisation_name and/or organisation_number. If you supply both, a name search will be conducted first, then the number will be checked against the result set and any remaining results returned.
organisation_numberstringOptional
The business number you wish to search on. This should be a unique corporate identifier as per the country registry you're searching.

Response

The request was valid and was successfully processed. The search has been carried out and the results are attached.
Companiesobject or null
ibContinuationKeystring or null
ibResponseCodeinteger or null
service provider response code
ibResponseDetailsstring or null
ibTransactionIdstring or null
service provider ID
requestIdstring or nullformat: "ulid"

Unique identifier for every request. Can be used for tracking down answers with technical support.

Uses the ULID format (a time-based, sortable UUID)

Note: this will be different for every request.

Errors