Lookup a Business | FrankieOne

You can lookup a business in authoritative registries for a given region by supplying either their name or the registration number relevant to the jurisdiction (eg: ACN in Australia). This allows you to confirm that the organization exists, and we also fetch additional details such as their current legal status in supported regions.

The name need not be the full legal name; partial name search is supported by many regional registries.

Perform a business lookup with a partial name or number using the /lookup endpoint.

In the example below, replace YOUR_CUSTOMER_ID with your Customer ID and YOUR_API_KEY with your API key provided by FrankieOne.
Copy the resulting code into your command line, and run the command.

Request

1 curl --request POST \
2      --url https://api.uat.frankie.one/v2.1/organizations/lookup \
3      --header 'X-Frankie-CustomerId: YOUR_CUSTOMER_ID' \
4      --header 'api_key: YOUR_API_KEY'
5      --header 'content-type: application/json' \
6      --data '{
7     	"organizationName": "FrankieOne",
8     	"region": {
9     		"country": "AUS"
10     	}
11     }'

Response

The response will contain a list of businesses that matched against the lookup criteria supplied

1 {
2     "matchedOrganizations": [
3         {
4             "addresses": [
5                 {
6                     "country": "AUS",
7                     "postalCode": "3000",
8                     "subdivision": "VIC",
9                     "type": "OFFICE_LOCALITY",
10                     "unstructuredLongForm": "VIC 3000"
11                 }
12             ],
13             "alternateNames": [
14                 {
15                     "name": "FRANKIE FINANCIAL PTY LTD",
16                     "type": "Trading name"
17                 },
18                 {
19                     "name": "FRANKIEONE",
20                     "type": "Trading name"
21                 }
22             ],
23             "country": "AUS",
24             "name": {
25                 "name": "FRANKIE FINANCIAL PTY LTD"
26             },
27             "organizationToken": "eyJ2ZXIiOiIxLjAiLCJ0cyI6IjIwMjUtMDktMTBUMDQ6Mzc6MDIuMDg3MDU3MzMzWiIsIm9uIjpbeyJybiI6IjYxNjIzNTA2ODkyIiwicmEiOiJBQk4ifSx7InJuIjoiNjIzNTA2ODkyIiwicmEiOiJBQ04ifV0sInByb3YiOiJjcmVkaXRvcndhdGNoIiwiY28iOiJBVVMifQ==",
28             "registrationDetails": [
29                 {
30                     "registrationNumber": "61623506892",
31                     "registrationNumberType": "ABN"
32                 },
33                 {
34                     "registrationNumber": "623506892",
35                     "registrationNumberType": "ACN"
36                 }
37             ],
38             "status": {
39                 "normalized": {
40                     "code": "ACTV"
41                 },
42                 "unstructured": {
43                     "description": "Registered"
44                 }
45             },
46             "type": {
47                 "code": "PRV",
48                 "description": "Australian Private Company"
49             }
50         }
51     ],
52     "queryDetails": {
53         "organizationName": "FrankieOne",
54         "region": {
55             "country": "AUS"
56         }
57     },
58     "requestId": "01K4RYKAYFKYY7JJVEX234B0FN"
59 }

Extract the organizationToken

What's it used for?

The organizationToken is used in subsequent steps to create an organization entity or to run a workflow.

Lookup may return multiple matches. Each match will have some business details and a unique organizationToken. Be sure to extract the organizationToken matching the details of the organization you intend to process.

For example, extract the organizationToken for the first matched result:

Retrieving a Company code

1 const organizationToken = response["matchedOrganizations"][0]["organizationToken"];