Skip to main content
POST
/
v2.1
/
organizations
/
profile
Organization Profile
curl --request POST \
  --url https://api.uat.frankie.one/v2.1/organizations/profile \
  --header 'Content-Type: application/json' \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api-key>' \
  --data '
{
  "organizationToken": "<string>",
  "organizationRegistration": {
    "region": {
      "country": "<string>",
      "subdivision": "<string>"
    },
    "organizationNumbers": [
      {
        "registrationNumber": "<string>",
        "registryCode": "<string>"
      }
    ]
  },
  "externalReferences": [
    {
      "name": "CUSTOMER-REFERENCE",
      "value": "CUST-00001342",
      "description": "This is the customer ID in the core banking system."
    }
  ],
  "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
'
{
  "organization": {
    "entityId": "07246f15-386b-4e37-a017-842ef03a4938",
    "entityType": "ORGANIZATION",
    "createdAt": "2024-09-20T01:54:46.003Z",
    "schemaVersion": 2,
    "addresses": [
      {
        "addressId": "b39ec506-712e-47b6-a0f5-50d9e5fb34e9",
        "sourceId": "d37e3af7-8c3b-48c7-8d50-3ec07d4375f9",
        "type": "BUSINESS",
        "validFrom": {
          "year": "2006",
          "month": "08",
          "day": "07",
          "unstructured": "2006-08-07"
        },
        "unitNumber": "LEVEL 1",
        "streetName": "141 BROADWAY",
        "locality": "NEDLANDS",
        "country": "AUS",
        "postalCode": "6009"
      }
    ],
    "phoneNumbers": [
      {
        "phoneNumberId": "e186babc-b36a-469b-834d-bb93aefc81e2",
        "isPreferred": true,
        "type": "MOBILE",
        "sourceId": "d37e3af7-8c3b-48c7-8d50-3ec07d4375f9",
        "country": "AUS",
        "number": "0426142240",
        "linkedAddresses": [
          {
            "addressId": "b39ec506-712e-47b6-a0f5-50d9e5fb34e9"
          }
        ]
      }
    ],
    "emailAddresses": [
      {
        "emailAddressId": "0205cd47-4d8f-4614-9e24-b652b031e661",
        "type": "WORK",
        "sourceId": "d37e3af7-8c3b-48c7-8d50-3ec07d4375f9",
        "email": "[email protected]",
        "isPreferred": true,
        "linkedAddresses": [
          {
            "addressId": "b39ec506-712e-47b6-a0f5-50d9e5fb34e9"
          }
        ]
      }
    ],
    "sourceId": "d37e3af7-8c3b-48c7-8d50-3ec07d4375f9",
    "websiteUrls": [
      {
        "websiteUrl": "websitesample.com",
        "sourceId": "d37e3af7-8c3b-48c7-8d50-3ec07d4375f9"
      }
    ],
    "details": {
      "type": {
        "code": "APUB",
        "description": "Australian Public Company",
        "sourceId": "d37e3af7-8c3b-48c7-8d50-3ec07d4375f9"
      },
      "class": {
        "code": "LMGT",
        "description": "Limited By Guarantee",
        "sourceId": "d37e3af7-8c3b-48c7-8d50-3ec07d4375f9"
      },
      "subClass": {
        "code": "LIST",
        "description": "Listed Public Company",
        "sourceId": "d37e3af7-8c3b-48c7-8d50-3ec07d4375f9"
      },
      "registrationDetails": [
        {
          "registry": "ABR",
          "registryDescription": {
            "code": "ABR",
            "description": "Australian Business Register"
          },
          "class": {
            "code": "LMSH",
            "description": "Limited By Shares",
            "sourceId": "d37e3af7-8c3b-48c7-8d50-3ec07d4375f9"
          },
          "status": {
            "normalized": {
              "code": "ACTV",
              "description": "ACTIVE"
            },
            "unstructured": {
              "code": "REGD",
              "description": "Registered"
            },
            "sourceId": "d37e3af7-8c3b-48c7-8d50-3ec07d4375f9"
          },
          "isCurrent": true,
          "registeredName": "INSURANCE AUSTRALIA LIMITED",
          "registeredNameDetails": {
            "validFrom": {
              "year": "2006",
              "month": "08",
              "day": "07",
              "unstructured": "2006-08-07",
              "normalized": "2006-08-07"
            },
            "validTo": {
              "year": "2006",
              "month": "08",
              "day": "07",
              "unstructured": "2006-08-07",
              "normalized": "2006-08-07"
            }
          },
          "registeredDate": {
            "year": "2006",
            "month": "08",
            "day": "07",
            "unstructured": "2006-08-07",
            "normalized": "2006-08-07"
          },
          "extractedDate": {
            "year": "2006",
            "month": "08",
            "day": "07",
            "unstructured": "2006-08-07",
            "normalized": "2006-08-07"
          },
          "registrationNumber": "11000016722",
          "registrationNumberType": "ABN",
          "registrationNumberDescription": "Australian Business Number",
          "updatedDate": {
            "year": "2006",
            "month": "08",
            "day": "07",
            "unstructured": "2006-08-07",
            "normalized": "2006-08-07"
          }
        }
      ],
      "jurisdiction": {
        "registry": "ABR",
        "registryDescription": {
          "code": "ABR",
          "description": "Australian Business Register"
        },
        "country": "AUS"
      },
      "industryCodes": [
        {
          "code": "1112",
          "description": "Poultry Processing",
          "type": "ANZSIC",
          "sourceId": "d37e3af7-8c3b-48c7-8d50-3ec07d4375f9"
        }
      ]
    },
    "shareholders": [
      {
        "entityId": "63e9b929-666b-4335-bf10-14b82a9e378c",
        "entityType": "INDIVIDUAL",
        "totalShares": 7000,
        "shareholdings": [
          {
            "class": "ORD",
            "shares": 7000,
            "nominalValue": "string",
            "isFullyPaid": true,
            "amountPaid": "0",
            "amountDue": "0",
            "amount": "0"
          },
          {
            "percentage": 0
          },
          {
            "isNonBeneficiallyHeld": false
          },
          {
            "isJointlyHeld": false
          },
          {
            "holdingType": [
              "SHARE"
            ]
          }
        ]
      }
    ],
    "officials": [
      {
        "entityId": "36166bc7-6212-4e03-86a4-e2f18ad78249",
        "entityType": "INDIVIDUAL",
        "officialId": "b89b492f-ab0f-4749-a583-4fc22401885c",
        "officialType": "OFFICIAL",
        "role": {
          "code": "DR",
          "description": "Director"
        },
        "identification": [
          {
            "type": "DIRECTOR_IDENTIFICATION_NUMBER"
          }
        ],
        "status": {
          "normalized": {
            "code": "Current",
            "description": "Current"
          },
          "unstructured": {
            "code": "Current",
            "description": "Current"
          },
          "sourceId": "d37e3af7-8c3b-48c7-8d50-3ec07d4375f9"
        },
        "sourceId": "d37e3af7-8c3b-48c7-8d50-3ec07d4375f9",
        "appointmentDate": {
          "year": "2016",
          "month": "06",
          "day": "07",
          "unstructured": "2016-06-27",
          "normalized": "2016-06-27"
        }
      }
    ],
    "shareCapital": {
      "totalShareCount": 7000,
      "shareStructure": [
        {
          "class": "ORD",
          "classDescription": "ORDINARY SHARES (ORD)"
        }
      ],
      "capitalType": [
        "SHARE"
      ]
    },
    "indicators": [
      {
        "value": "Provider Fetch Error",
        "indicator": "PROVIDER_FETCH_ERROR",
        "type": "Object",
        "description": "Error in fetching data from Provider"
      }
    ],
    "updatedAt": "2024-09-20T01:54:46.005Z",
    "linkedIndividuals": {
      "additionalProp1": {
        "entityId": "63e9b929-666b-4335-bf10-14b82a9e378c",
        "entityType": "INDIVIDUAL",
        "createdAt": "2024-09-20T01:54:46.005Z",
        "schemaVersion": 2,
        "addresses": [
          {
            "addressId": "0a7ea9f9-857e-493f-abc3-9326632d2287",
            "sourceId": "d37e3af7-8c3b-48c7-8d50-3ec07d4375f9",
            "type": "BUSINESS",
            "streetName": "1223 LAURINO TERRACE",
            "locality": "SUBIACO",
            "country": "AUS",
            "postalCode": "6008",
            "status": "CURRENT"
          }
        ],
        "sourceId": "d37e3af7-8c3b-48c7-8d50-3ec07d4375f9",
        "name": {
          "nameId": "12c67bf9-23f8-4848-aaf6-4cc99d9cf990",
          "language": "eng",
          "givenName": "givenName02",
          "middleName": "middleName02",
          "familyName": "familyName02",
          "otherName": null,
          "sourceId": "d37e3af7-8c3b-48c7-8d50-3ec07d4375f9",
          "displayName": "givenName02 middleName02"
        },
        "dateOfBirth": {
          "dateOfBirthId": "string",
          "sourceId": "d37e3af7-8c3b-48c7-8d50-3ec07d4375f9",
          "year": "1976",
          "month": "03",
          "day": "29",
          "unstructured": "1976-03-29",
          "normalized": "1976-03-29"
        },
        "gender": {
          "gender": "MALE",
          "sourceId": "d37e3af7-8c3b-48c7-8d50-3ec07d4375f9"
        },
        "nationality": "AUS"
      }
    },
    "ultimateBeneficialOwners": [
      {
        "entityId": "63e9b929-666b-4335-bf10-14b82a9e378c",
        "entityType": "INDIVIDUAL",
        "percentageOwned": {
          "total": 7000,
          "isTotalNearZero": false,
          "beneficially": 7000,
          "isBeneficialNearZero": false,
          "nonBeneficially": 0,
          "isNonBeneficialNearZero": false,
          "isContainingJointOwnership": false
        },
        "sourceId": "d37e3af7-8c3b-48c7-8d50-3ec07d4375f9"
      }
    ],
    "informationSources": {
      "additionalProp1": {
        "sourceId": "d37e3af7-8c3b-48c7-8d50-3ec07d4375f9",
        "type": "ID number",
        "source": "Client",
        "provider": "equifax-au",
        "providerReference": "",
        "createdAt": "2024-01-15T02:18:11.365Z",
        "requestedAt": "2024-01-15T02:18:11.365Z",
        "generatedAt": "2024-01-15T02:18:11.365Z",
        "retrievedAt": "2024-01-15T02:18:11.365Z",
        "updatedAt": "2024-01-15T02:18:11.365Z",
        "isAuthoritative": false,
        "isManual": true
      }
    }
  },
  "requestId": "01J9493GTXQKY4K5VQ8Z9Q8NKK"
}

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.

Query Parameters

​
forceRefresh
boolean

This will fetch the latest information from the registry if set to true.

​
includeDeregisteredCompanies
boolean

Whether to include deregistered companies in the response. Defaults to false. If flag is false, and the requested company is deregistered, then error is returned. If flag is true, and the requested company is deregistered, then a standard profile response provided including details about the deregistered company. If flag is true, and the requested company is not deregistered, then a standard profile response is provided. Note: this flag only works to get a domestic profile, otherwise flag will be ignored.

Body

application/json
​
organizationToken
string

This is the unique Frankie token that contains all the information required from lookup that are needed in succeeding steps

​
organizationRegistration
object
​
externalReferences
object[]
​
entityId
string

Entities are assigned a FrankieOne auto-generated UUID to ensure global uniqueness, represented as entityId. The entityId allows for precise modification when required. To modify an entity, set the entityId of the entity you wish to update in an update request.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Response

OK

​
requestId
string
required

The unique request identifier for the API call made.

Example:

"01HN9XHZN6MGXM9JXG50K59Q85"

​
organization
object

This is the complete Organization Model

​
serviceProfiles
object[]