Skip to main content
POST
/
v2
/
organizations
/
lookup
Organizations Lookup
curl --request POST \
  --url https://api.frankie.one/v2/organizations/lookup \
  --header 'Content-Type: application/json' \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api-key>' \
  --data '
{
  "region": {
    "country": "<string>",
    "subdivision": "<string>"
  },
  "organizationName": "<string>",
  "organizationNumber": {
    "registrationNumber": "<string>",
    "registryCode": "<string>"
  }
}
'
{
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
  "matchedOrganizations": [
    {
      "organizationToken": "<string>",
      "country": "<string>",
      "type": {
        "code": "<string>",
        "description": "<string>"
      },
      "addresses": [
        {
          "country": "<string>",
          "addressId": "<string>",
          "sourceId": "<string>",
          "type": "OTHER",
          "typeDescription": "<string>",
          "validFrom": {
            "year": "1990",
            "month": "03",
            "day": "27",
            "unstructured": "12 Rajab 1445 AH",
            "type": "GREGORIAN",
            "normalized": "1990-03-31"
          },
          "validTo": {
            "year": "1990",
            "month": "03",
            "day": "27",
            "unstructured": "12 Rajab 1445 AH",
            "type": "GREGORIAN",
            "normalized": "1990-03-31"
          },
          "longForm": "<string>",
          "unitNumber": "<string>",
          "buildingName": "<string>",
          "streetName": "<string>",
          "streetNumber": "<string>",
          "streetType": "<string>",
          "neighborhood": "<string>",
          "locality": "<string>",
          "district": "<string>",
          "subdivision": "<string>",
          "postalCode": "<string>",
          "careOf": "<string>",
          "status": "CURRENT",
          "unstructuredLongForm": "<string>"
        }
      ],
      "registrationDetails": [
        {
          "registrationNumber": "<string>",
          "registry": "<string>",
          "registryDescription": "<string>",
          "isCurrent": true,
          "registeredName": "<string>",
          "registeredNameDetails": {
            "validFrom": {
              "year": "1990",
              "month": "03",
              "day": "27",
              "unstructured": "12 Rajab 1445 AH",
              "type": "GREGORIAN",
              "normalized": "1990-03-31"
            },
            "validTo": {
              "year": "1990",
              "month": "03",
              "day": "27",
              "unstructured": "12 Rajab 1445 AH",
              "type": "GREGORIAN",
              "normalized": "1990-03-31"
            }
          },
          "registeredDate": {
            "year": "1990",
            "month": "03",
            "day": "27",
            "unstructured": "12 Rajab 1445 AH",
            "type": "GREGORIAN",
            "normalized": "1990-03-31"
          },
          "extractedDate": {
            "year": "1990",
            "month": "03",
            "day": "27",
            "unstructured": "12 Rajab 1445 AH",
            "type": "GREGORIAN",
            "normalized": "1990-03-31"
          },
          "registeredSubdivision": "<string>",
          "registeredCountry": "<string>",
          "registrationStatus": {
            "normalized": {
              "code": "<string>",
              "description": "<string>"
            },
            "unstructured": {
              "code": "<string>",
              "description": "<string>"
            }
          },
          "registrationNumberType": "<string>",
          "registrationNumberDescription": "<string>",
          "updatedDate": {
            "year": "1990",
            "month": "03",
            "day": "27",
            "unstructured": "12 Rajab 1445 AH",
            "type": "GREGORIAN",
            "normalized": "1990-03-31"
          },
          "reviewDate": {
            "year": "1990",
            "month": "03",
            "day": "27",
            "unstructured": "12 Rajab 1445 AH",
            "type": "GREGORIAN",
            "normalized": "1990-03-31"
          },
          "foundationDate": {
            "year": "1990",
            "month": "03",
            "day": "27",
            "unstructured": "12 Rajab 1445 AH",
            "type": "GREGORIAN",
            "normalized": "1990-03-31"
          },
          "isSuppressed": true,
          "validFrom": {
            "year": "1990",
            "month": "03",
            "day": "27",
            "unstructured": "12 Rajab 1445 AH",
            "type": "GREGORIAN",
            "normalized": "1990-03-31"
          },
          "validTo": {
            "year": "1990",
            "month": "03",
            "day": "27",
            "unstructured": "12 Rajab 1445 AH",
            "type": "GREGORIAN",
            "normalized": "1990-03-31"
          }
        }
      ],
      "alternateNames": [
        {
          "name": "<string>",
          "type": "<string>",
          "validFrom": {
            "year": "1990",
            "month": "03",
            "day": "27",
            "unstructured": "12 Rajab 1445 AH",
            "type": "GREGORIAN",
            "normalized": "1990-03-31"
          },
          "validTo": {
            "year": "1990",
            "month": "03",
            "day": "27",
            "unstructured": "12 Rajab 1445 AH",
            "type": "GREGORIAN",
            "normalized": "1990-03-31"
          },
          "sourceId": "<string>"
        }
      ],
      "name": {
        "name": "<string>",
        "type": "<string>",
        "validFrom": {
          "year": "1990",
          "month": "03",
          "day": "27",
          "unstructured": "12 Rajab 1445 AH",
          "type": "GREGORIAN",
          "normalized": "1990-03-31"
        },
        "validTo": {
          "year": "1990",
          "month": "03",
          "day": "27",
          "unstructured": "12 Rajab 1445 AH",
          "type": "GREGORIAN",
          "normalized": "1990-03-31"
        },
        "sourceId": "<string>"
      },
      "status": {
        "normalized": {
          "code": "<string>",
          "description": "<string>"
        },
        "unstructured": {
          "code": "<string>",
          "description": "<string>"
        }
      },
      "phoneNumbers": [
        {
          "phoneNumberId": "ad165f64-5717-4562-b3fc-2c963f66bfa9",
          "isPreferred": true,
          "type": "MOBILE",
          "sourceId": "14fd5f64-5717-4562-b3fc-2c963f66ba34",
          "country": "AUS",
          "number": "0426192340",
          "linkedAddresses": [
            {
              "addressId": "fa335f64-5717-4562-b3fc-2c963f66cf41"
            }
          ],
          "unstructuredLongForm": "<string>"
        }
      ],
      "emailAddresses": [
        {
          "emailAddressId": "aa385f64-5717-4562-b3fc-2c963f66af21",
          "type": "WORK",
          "sourceId": "31dd15f64-5717-4562-b3fc-2c963f66234d",
          "email": "[email protected]",
          "isPreferred": true,
          "linkedAddresses": [
            {
              "addressId": "adc215f64-5717-4562-b3fc-2c963f66222a"
            }
          ]
        }
      ],
      "websiteUrls": [
        {
          "websiteUrl": "<string>",
          "sourceId": "<string>"
        }
      ],
      "subdivision": "<string>"
    }
  ],
  "queryDetails": {
    "region": {
      "country": "<string>",
      "subdivision": "<string>"
    },
    "organizationName": "<string>",
    "organizationNumber": {
      "registrationNumber": "<string>",
      "registryCode": "<string>"
    }
  }
}

Authorizations

​
api_key
string
header
required

Headers

​
api_key
string
required

Your API key provided by FrankieOne

Example:

"245c765b124a098d09ef8765...."

​
X-Frankie-CustomerID
string
required

Your Customer ID provided by FrankieOne

Example:

"12345678-1234-1234-1234-123456789012"

​
X-Frankie-CustomerChildID
string

Your Customer Child ID provided by FrankieOne

Example:

"87654321-4321-4321-4321-210987654321"

​
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

An organization name or a number needs to be provided with region information to lookup in the specific jurisidiction.

Contains the criteria used to lookup for organizations.

​
region
object
required
​
organizationName
string

The name of the organization that we are looking up for

​
organizationNumber
object

Response

OK

​
requestId
string
required

The unique request identifier for the API call made.

Example:

"01HN9XHZN6MGXM9JXG50K59Q85"

​
matchedOrganizations
object[]
required

An array of organizations matching the provided lookup criteria

​
queryDetails
object
required

Contains the criteria used to lookup for organizations.