Financial API EndpointsBusiness

(International) Retrieve a business profile from any country.

Using the Company Code retrieved from the search response (see above: https://docs.frankieone.com/reference/internationalbusinesssearch) you can pull back the details of the company.

The FrankieOne platform will save the details of the response as an ORGANISATION type entity with the retrieved profile attached as a report which you can potentially re-retrieve later if you wish.

Headers

api_keystringRequired
X-Frankie-CustomerIDstringRequired
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-CustomerChildIDstringOptional

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-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.
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

company_codestringOptional

This is the company number returned in the search results

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

registration_authority_codestringOptional
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.
CompanyProfileobjectOptional
checkIdstringOptionalformat: "uuid"
Unique ID for the individual check that was run.
entityCreatedDatedatetimeOptional
The date and time this entity was created in our service.
entityIdstringOptionalformat: "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.
entityUpdatedDatedatetimeOptional
The date and time this entity was last updated in our service.
ibResponseCodeintegerOptional
service provider response code
ibResponseDetailsstringOptional
ibRetrievalLocationstringOptional
ibTransactionIdstringOptional
service provider ID
requestIdstringOptional

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