Skip to main content
POST
/
business
/
international
/
search
(International) Search for a business from any country.
curl --request POST \
  --url https://api.uat.frankie.one/compliance/v1.2/business/international/search \
  --header 'Content-Type: application/json' \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api-key>' \
  --data '
{
  "country": "<string>",
  "cached_search": true,
  "organisation_name": "<string>",
  "organisation_number": "<string>"
}
'
{
  "Companies": {
    "CompanyDTO": [
      {
        "Addresses": {
          "Addresses": [
            {
              "AddressInOneLine": "<string>",
              "AddressLine1": "<string>",
              "AddressLine2": "<string>",
              "AddressLine3": "<string>",
              "AddressLine4": "<string>",
              "AddressLine5": "<string>",
              "CityTown": "<string>",
              "ConcatenatedAddress": "<string>",
              "Country": "<string>",
              "Email": "<string>",
              "FaxNumber": "<string>",
              "Line": {
                "AddressLineDTO": [
                  {
                    "Line": "<string>",
                    "Type": "<string>",
                    "TypeCode": "<string>"
                  }
                ]
              },
              "Postcode": "<string>",
              "RegionState": "<string>",
              "TelephoneNumber": "<string>",
              "Type": "<string>",
              "TypeCode": "<string>",
              "WebsiteUrl": "<string>"
            }
          ]
        },
        "Aliases": {
          "AddressLine": [
            "<string>"
          ]
        },
        "AliasesList": [
          "<string>"
        ],
        "Code": "<string>",
        "CompanyID": "<string>",
        "CompanyNameInEnglish": "<string>",
        "Date": "<string>",
        "Function": "<string>",
        "LegalForm": "<string>",
        "LegalStatus": "<string>",
        "MoreKey": "<string>",
        "Name": "<string>",
        "Official": true,
        "RegistrationAuthority": "<string>",
        "RegistrationAuthorityCode": "<string>",
        "Source": "<string>",
        "VirtualID": "<string>"
      }
    ]
  },
  "ibContinuationKey": "<string>",
  "ibResponseCode": 123,
  "ibResponseDetails": "<string>",
  "ibTransactionId": "<string>",
  "requestId": "01BFJA617JMJXEW6G7TDDXNSHX"
}

Authorizations

​
api_key
string
header
required

API key issued by Frankie Financial. This will rotate regularly.

Headers

​
X-Frankie-CustomerID
string<uuid>
required

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-CustomerChildID
string<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-Channel
string

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.

Body

application/json

The country, name or business number of the organisation to be queried.

Object to supply the country code, business name and number, along with an optional registry parameter to search for.

​
country
string
required

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

​
cached_search
boolean

Flag to use the cache search functionality of provider.

​
organisation_name
string

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_number
string

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.

This wraps the search response details from Kyckr

​
Companies
object
​
ibContinuationKey
string
​
ibResponseCode
integer

service provider response code

​
ibResponseDetails
string
​
ibTransactionId
string

service provider ID

​
requestId
string<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.

Example:

"01BFJA617JMJXEW6G7TDDXNSHX"