Skip to main content
POST
/
business
/
international
/
profile
(International) Retrieve a business profile from any country.
curl --request POST \
  --url https://api.uat.frankie.one/compliance/v1.2/business/international/profile \
  --header 'Content-Type: application/json' \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api-key>' \
  --data '
{
  "country": "<string>",
  "company_code": "<string>",
  "registration_authority_code": "<string>"
}
'
{
  "CompanyProfile": {
    "Activity": {
      "ActivityDTO": [
        {
          "Code": "<string>",
          "Description": "<string>"
        }
      ]
    },
    "ActivityDeclaration": {
      "ActivityDeclarationDTO": [
        {
          "Declaration": "<string>",
          "DeclarationDescription": "<string>",
          "Language": "<string>"
        }
      ]
    },
    "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>"
        }
      ]
    },
    "AgentAddress": "<string>",
    "AgentName": "<string>",
    "Aliases": {
      "AddressLine": [
        "<string>"
      ]
    },
    "AliasesList": [
      "<string>"
    ],
    "AppointmentDateOfOfficial": "<string>",
    "Capital": {
      "CapitalDTO": [
        {
          "Ammount": "<string>",
          "Currency": "<string>",
          "Type": "<string>",
          "TypeCode": "<string>"
        }
      ]
    },
    "Code": "<string>",
    "CompanyNameInEnglish": "<string>",
    "Date": "<string>",
    "Email": "<string>",
    "FaxNumber": "<string>",
    "FiscalCode": "<string>",
    "FoundationDate": "<string>",
    "Functions": {
      "AddressLine": [
        "<string>"
      ]
    },
    "FunctionsList": [
      "<string>"
    ],
    "Headquarters": "<string>",
    "KeyFigures": {
      "AddressLine": [
        "<string>"
      ]
    },
    "KeyFiguresList": [
      "<string>"
    ],
    "LastAnnualAccountDate": "<string>",
    "LegalForm": "<string>",
    "LegalFormDeclaration": "<string>",
    "LegalFormDetails": {
      "Basis": "<string>",
      "Capital": "<string>",
      "Comments": "<string>",
      "Control": "<string>",
      "Incorp": "<string>",
      "Partner": "<string>",
      "Responsibility": "<string>",
      "Stocks": "<string>"
    },
    "LegalStatus": "<string>",
    "MailingAddress": "<string>",
    "Name": "<string>",
    "NormalisedLegalForm": "PUBLIC COMPANY",
    "NormalisedLegalStatus": "<string>",
    "NormalisedRegistrationDate": "2023-04-23",
    "Official": true,
    "RegistrationAuthority": "<string>",
    "RegistrationAuthorityCode": "<string>",
    "RegistrationDate": "<string>",
    "RegistrationNumber": "<string>",
    "SigningDeclaration": "<string>",
    "SigningDeclarationDescription": "<string>",
    "SigningLanguage": "<string>",
    "Source": "<string>",
    "StateOfIncorporation": "<string>",
    "TelephoneNumber": "<string>",
    "VatNumber": "<string>",
    "VirtualId": "<string>",
    "WebsiteURL": "<string>",
    "directorAndShareDetails": {
      "PersonsOfSignificantControl": {
        "PSCDetails": [
          {
            "Address": "<string>",
            "CeasedOn": "<string>",
            "CountryOfResidence": "<string>",
            "DOBDay": 123,
            "DOBMonth": 123,
            "DOBYear": 123,
            "Kind": "<string>",
            "Name": "<string>",
            "Nationality": "<string>",
            "NatureOfControl": {
              "AddressLine": [
                "<string>"
              ]
            },
            "NatureOfControlList": [
              "<string>"
            ],
            "NotifiedOn": "<string>"
          }
        ]
      },
      "capitalReserves": {
        "capitalreserves": "<string>",
        "networth": "<string>",
        "paidupequity": "<string>",
        "profitlossreserve": "<string>",
        "reserves": "<string>",
        "revalutationreserve": "<string>",
        "shareholderfunds": "<string>",
        "sundryreserves": "<string>"
      },
      "directors": {
        "Director": [
          {
            "address1": "<string>",
            "address2": "<string>",
            "address3": "<string>",
            "address4": "<string>",
            "address5": "<string>",
            "address6": "<string>",
            "birthdate": "<string>",
            "directorNumber": "<string>",
            "directorships": {
              "Directorship": [
                {
                  "appointedDate": "<string>",
                  "companyName": "<string>",
                  "companyNumber": "<string>",
                  "companyStatus": "<string>",
                  "function": "<string>"
                }
              ]
            },
            "name": "<string>",
            "nationality": "<string>",
            "postcode": "<string>",
            "title": "<string>"
          }
        ]
      },
      "shareHolderSummary": {
        "shareCapital": "<string>"
      },
      "shareHolders": {
        "ShareholderDetails": [
          {
            "address": "<string>",
            "allInfo": "<string>",
            "currency": "<string>",
            "id": "<string>",
            "name": "<string>",
            "nationality": "<string>",
            "nominalValue": "<string>",
            "percentage": "<string>",
            "shareClass": "<string>",
            "shareCount": 123,
            "shareType": "<string>",
            "shareholderType": "<string>",
            "totalShareCount": 123,
            "totalShareValue": 123,
            "totalShares": 123
          }
        ]
      }
    },
    "officers": {
      "USOfficerDTO": [
        {
          "Address": "<string>",
          "BusinessAddress": {
            "AddressLine": [
              "<string>"
            ]
          },
          "Date": "<string>",
          "MailingAddress": "<string>",
          "Name": "<string>",
          "Title": "<string>",
          "Type": "<string>"
        }
      ]
    }
  },
  "checkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "entityCreatedDate": "2023-11-07T05:31:56Z",
  "entityId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
  "entityUpdatedDate": "2023-11-07T05:31:56Z",
  "ibResponseCode": 123,
  "ibResponseDetails": "<string>",
  "ibRetrievalLocation": "<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 Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-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, company code and optional registry of the organisation to be queried.

Object to supply the country code and company code whose details you wish to retrieve.

​
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

​
company_code
string

This is the company number returned in the search results

(InternationalBusinessSearchResponse.Companies.CompanyDTO[n].Code)

​
registration_authority_code
string

The registration authority code you wish to search on. This will be used when the country you are searching has multiple registration authorities.

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

​
CompanyProfile
object
​
checkId
string<uuid>

Unique ID for the individual check that was run.

​
entityCreatedDate
string<date-time>

The date and time this entity was created in our service.

​
entityId
string<uuid>

If the response was successful and we returned a company profile, we save this as an ORGANISATION type entity in our service. We will also save the profile result as a REPORT type document, attached to the entity.

Example:

"84a9a860-68ae-4d7d-9a53-54a1116d5051"

​
entityUpdatedDate
string<date-time>

The date and time this entity was last updated in our service.

​
ibResponseCode
integer

service provider response code

​
ibResponseDetails
string
​
ibRetrievalLocation
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"