Skip to main content
POST
/
entity
/
{entityId}
Update Existing Entity
curl --request POST \
  --url https://api.uat.frankie.one/compliance/v1.2/entity/{entityId} \
  --header 'Content-Type: application/json' \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api-key>' \
  --data '
{
  "addresses": [
    {
      "country": "AUS",
      "addressId": "86932629-bdb4-158f-e670-741e89ff78ba",
      "addressType": "REGISTERED_OFFICE",
      "buildingName": "Highland Tower",
      "careOf": "<string>",
      "endDate": "0001-01-01",
      "extraData": [
        {
          "kvpKey": "ACN",
          "kvpType": "id.external",
          "kvpValue": "406655338"
        }
      ],
      "longForm": "42a Test Eagle Road, Testville, TST 123-TST, Testalia",
      "postalCode": "3000",
      "region": "MELBOURNE",
      "startDate": "2023-03-10",
      "state": "VIC",
      "streetName": "9 ROYCE AVENUE",
      "streetNumber": "FLAT 27",
      "streetType": "Road",
      "suburb": "Testburb",
      "town": "MELBOURNE",
      "unitNumber": "FLAT 27",
      "unstructuredLongForm": "<string>"
    }
  ],
  "dateOfBirth": {
    "country": "AUS",
    "dateOfBirth": "1978-11-12",
    "locality": "Brisbane",
    "unstructuredDateOfBirth": "<string>",
    "yearOfBirth": "1978"
  },
  "entityId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
  "entityProfile": "<string>",
  "entityType": "ORGANISATION",
  "extraData": [
    {
      "kvpKey": "ACN",
      "kvpType": "id.external",
      "kvpValue": "406655338"
    }
  ],
  "flags": [
    {
      "flag": "<string>",
      "value": 123
    }
  ],
  "gender": "F",
  "identityDocs": [
    {
      "country": "AUS",
      "idType": "DRIVERS_LICENCE",
      "docScan": [
        {
          "ScanDelete": true,
          "scanCreated": "2020-06-02",
          "scanData": "VGhpcyBpcyBzb21lIGV4YW1wbGUgZGF0YS4gV29vLCBJIGJldCB5b3UgcmVncmV0IHRoZSB0aW1lIHlvdSB3YXN0ZWQgZGVjb2RpbmcgdGhpcywgaHVoPw==",
          "scanDataRetrievalState": "NORMAL",
          "scanDocId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
          "scanFilename": "Important Document - ID1234567.pdf",
          "scanMIME": "image/png",
          "scanPageNum": 1,
          "scanSide": "F",
          "scanType": "PDF"
        }
      ],
      "documentId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
      "documentStatus": "DOC_SCANNED",
      "extraData": [
        {
          "kvpKey": "ACN",
          "kvpType": "id.external",
          "kvpValue": "406655338"
        }
      ],
      "idExpiry": "2020-02-01",
      "idIssued": "1972-11-04",
      "idNumber": "123456789",
      "idSubType": "<string>",
      "region": "VIC"
    }
  ],
  "name": {
    "familyName": "Smith",
    "displayName": "Jane Cecily Smith",
    "givenName": "Jane",
    "honourific": "Duchess",
    "middleName": "Cecily"
  },
  "organisationData": {
    "adverseCreditDataPresent": true,
    "aliases": [
      "<string>"
    ],
    "class": {
      "code": "<string>",
      "description": "<string>"
    },
    "contactDetails": {
      "email": "<string>",
      "faxNumber": "<string>",
      "telephoneNumber": "<string>",
      "websiteURL": "<string>"
    },
    "disclosingEntityIndicator": true,
    "extractedDate": "2023-12-25",
    "includesNonBeneficiallyHeld": true,
    "industryCodes": [
      {
        "code": "<string>",
        "description": "<string>"
      }
    ],
    "industryDeclarations": [
      {
        "description": "<string>",
        "language": "<string>"
      }
    ],
    "kycCustomerType": "<string>",
    "lastCheckDate": "2023-12-25",
    "legalFormDetails": {
      "basis": "<string>",
      "capital": "<string>",
      "comments": "<string>",
      "control": "<string>",
      "incorp": "<string>",
      "partner": "<string>",
      "responsibility": "<string>",
      "stocks": "<string>"
    },
    "normalisedLegalStatus": "<string>",
    "ownershipResolved": true,
    "registeredName": "<string>",
    "registration": {
      "countryIso": "<string>",
      "date": "2023-12-25",
      "number": "<string>",
      "previousNumber": "<string>",
      "registryCode": "<string>",
      "registryDescription": "<string>",
      "state": "<string>",
      "unstructuredDate": "<string>",
      "unstructuredFoundationDate": "<string>"
    },
    "registries": {
      "abr": {
        "abn": "<string>",
        "acn": "<string>",
        "addresses": [
          {
            "effectiveFrom": "2023-11-07T05:31:56Z",
            "effectiveTo": "2023-11-07T05:31:56Z",
            "postcode": "<string>",
            "stateCode": "<string>"
          }
        ],
        "businessNames": [
          {
            "effectiveFrom": "2023-11-07T05:31:56Z",
            "effectiveTo": "2023-11-07T05:31:56Z",
            "name": "<string>",
            "type": "<string>"
          }
        ],
        "charityEndorsements": [
          {
            "effectiveFrom": "2023-11-07T05:31:56Z",
            "effectiveTo": "2023-11-07T05:31:56Z",
            "type": "<string>"
          }
        ],
        "charityTypes": [
          {
            "description": "<string>",
            "effectiveFrom": "2023-11-07T05:31:56Z",
            "effectiveTo": "2023-11-07T05:31:56Z"
          }
        ],
        "description": "<string>",
        "dgrEndorsements": [
          {
            "endorsedFrom": "2023-11-07T05:31:56Z",
            "endorsedTo": "2023-11-07T05:31:56Z"
          }
        ],
        "gst": [
          {
            "effectiveFrom": "2023-11-07T05:31:56Z",
            "effectiveTo": "2023-11-07T05:31:56Z"
          }
        ],
        "historicalChanges": [
          {
            "businessName": [
              "<string>"
            ],
            "date": "2023-11-07T05:31:56Z",
            "entityStatus": [
              "<string>"
            ],
            "goodsAndServicesTax": [
              "<string>"
            ],
            "mainBusinessPhysicalAddress": [
              "<string>"
            ],
            "mainName": [
              "<string>"
            ],
            "mainTradingName": [
              "<string>"
            ]
          }
        ],
        "lastUpdated": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "registeredDate": "2023-11-07T05:31:56Z",
        "status": "<string>",
        "statusEffectiveFrom": "<string>",
        "type": "<string>",
        "typeCode": "<string>",
        "updatedDate": "2023-11-07T05:31:56Z"
      }
    },
    "reviewDate": "2023-12-25",
    "shareStructure": [
      {
        "amountDue": 123,
        "amountPaid": 123,
        "classCode": "<string>",
        "classTitle": "<string>",
        "docNumber": "<string>",
        "docNumberQualifier": "<string>",
        "sharesIssued": 123,
        "status": "<string>"
      }
    ],
    "startDate": "2023-12-25",
    "status": {
      "code": "<string>",
      "description": "<string>"
    },
    "subType": {
      "code": "<string>",
      "description": "<string>"
    },
    "subclass": {
      "code": "<string>",
      "description": "<string>"
    },
    "type": {
      "code": "<string>",
      "description": "<string>"
    }
  }
}
'
{
  "entity": {
    "addresses": [
      {
        "country": "AUS",
        "addressId": "86932629-bdb4-158f-e670-741e89ff78ba",
        "addressType": "REGISTERED_OFFICE",
        "buildingName": "Highland Tower",
        "careOf": "<string>",
        "endDate": "0001-01-01",
        "extraData": [
          {
            "kvpKey": "ACN",
            "kvpType": "id.external",
            "kvpValue": "406655338"
          }
        ],
        "longForm": "42a Test Eagle Road, Testville, TST 123-TST, Testalia",
        "postalCode": "3000",
        "region": "MELBOURNE",
        "startDate": "2023-03-10",
        "state": "VIC",
        "streetName": "9 ROYCE AVENUE",
        "streetNumber": "FLAT 27",
        "streetType": "Road",
        "suburb": "Testburb",
        "town": "MELBOURNE",
        "unitNumber": "FLAT 27",
        "unstructuredLongForm": "<string>"
      }
    ],
    "dateOfBirth": {
      "country": "AUS",
      "dateOfBirth": "1978-11-12",
      "locality": "Brisbane",
      "unstructuredDateOfBirth": "<string>",
      "yearOfBirth": "1978"
    },
    "entityId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
    "entityProfile": "<string>",
    "entityType": "ORGANISATION",
    "extraData": [
      {
        "kvpKey": "ACN",
        "kvpType": "id.external",
        "kvpValue": "406655338"
      }
    ],
    "flags": [
      {
        "flag": "<string>",
        "value": 123
      }
    ],
    "gender": "F",
    "identityDocs": [
      {
        "country": "AUS",
        "idType": "DRIVERS_LICENCE",
        "createdFromScan": true,
        "docScan": [
          {
            "ScanDelete": true,
            "scanCreated": "2020-06-02",
            "scanData": "VGhpcyBpcyBzb21lIGV4YW1wbGUgZGF0YS4gV29vLCBJIGJldCB5b3UgcmVncmV0IHRoZSB0aW1lIHlvdSB3YXN0ZWQgZGVjb2RpbmcgdGhpcywgaHVoPw==",
            "scanDataRetrievalState": "NORMAL",
            "scanDocId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
            "scanFilename": "Important Document - ID1234567.pdf",
            "scanMIME": "image/png",
            "scanPageNum": 1,
            "scanSide": "F",
            "scanType": "PDF"
          }
        ],
        "documentId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
        "documentStatus": "DOC_SCANNED",
        "extraData": [
          {
            "kvpKey": "ACN",
            "kvpType": "id.external",
            "kvpValue": "406655338"
          }
        ],
        "idExpiry": "2020-02-01",
        "idIssued": "1972-11-04",
        "idNumber": "123456789",
        "idSubType": "<string>",
        "manuallyModified": "false",
        "region": "VIC"
      }
    ],
    "name": {
      "familyName": "Smith",
      "displayName": "Jane Cecily Smith",
      "givenName": "Jane",
      "honourific": "Duchess",
      "middleName": "Cecily"
    },
    "organisationData": {
      "adverseCreditDataPresent": true,
      "aliases": [
        "<string>"
      ],
      "class": {
        "code": "<string>",
        "description": "<string>"
      },
      "contactDetails": {
        "email": "<string>",
        "faxNumber": "<string>",
        "telephoneNumber": "<string>",
        "websiteURL": "<string>"
      },
      "disclosingEntityIndicator": true,
      "extractedDate": "2023-12-25",
      "includesNonBeneficiallyHeld": true,
      "industryCodes": [
        {
          "code": "<string>",
          "description": "<string>"
        }
      ],
      "industryDeclarations": [
        {
          "description": "<string>",
          "language": "<string>"
        }
      ],
      "kycCustomerType": "<string>",
      "lastCheckDate": "2023-12-25",
      "legalFormDetails": {
        "basis": "<string>",
        "capital": "<string>",
        "comments": "<string>",
        "control": "<string>",
        "incorp": "<string>",
        "partner": "<string>",
        "responsibility": "<string>",
        "stocks": "<string>"
      },
      "normalisedLegalStatus": "<string>",
      "ownershipResolved": true,
      "registeredName": "<string>",
      "registration": {
        "countryIso": "<string>",
        "date": "2023-12-25",
        "number": "<string>",
        "previousNumber": "<string>",
        "registryCode": "<string>",
        "registryDescription": "<string>",
        "state": "<string>",
        "unstructuredDate": "<string>",
        "unstructuredFoundationDate": "<string>"
      },
      "registries": {
        "abr": {
          "abn": "<string>",
          "acn": "<string>",
          "addresses": [
            {
              "effectiveFrom": "2023-11-07T05:31:56Z",
              "effectiveTo": "2023-11-07T05:31:56Z",
              "postcode": "<string>",
              "stateCode": "<string>"
            }
          ],
          "businessNames": [
            {
              "effectiveFrom": "2023-11-07T05:31:56Z",
              "effectiveTo": "2023-11-07T05:31:56Z",
              "name": "<string>",
              "type": "<string>"
            }
          ],
          "charityEndorsements": [
            {
              "effectiveFrom": "2023-11-07T05:31:56Z",
              "effectiveTo": "2023-11-07T05:31:56Z",
              "type": "<string>"
            }
          ],
          "charityTypes": [
            {
              "description": "<string>",
              "effectiveFrom": "2023-11-07T05:31:56Z",
              "effectiveTo": "2023-11-07T05:31:56Z"
            }
          ],
          "description": "<string>",
          "dgrEndorsements": [
            {
              "endorsedFrom": "2023-11-07T05:31:56Z",
              "endorsedTo": "2023-11-07T05:31:56Z"
            }
          ],
          "gst": [
            {
              "effectiveFrom": "2023-11-07T05:31:56Z",
              "effectiveTo": "2023-11-07T05:31:56Z"
            }
          ],
          "historicalChanges": [
            {
              "businessName": [
                "<string>"
              ],
              "date": "2023-11-07T05:31:56Z",
              "entityStatus": [
                "<string>"
              ],
              "goodsAndServicesTax": [
                "<string>"
              ],
              "mainBusinessPhysicalAddress": [
                "<string>"
              ],
              "mainName": [
                "<string>"
              ],
              "mainTradingName": [
                "<string>"
              ]
            }
          ],
          "lastUpdated": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "registeredDate": "2023-11-07T05:31:56Z",
          "status": "<string>",
          "statusEffectiveFrom": "<string>",
          "type": "<string>",
          "typeCode": "<string>",
          "updatedDate": "2023-11-07T05:31:56Z"
        }
      },
      "reviewDate": "2023-12-25",
      "shareStructure": [
        {
          "amountDue": 123,
          "amountPaid": 123,
          "classCode": "<string>",
          "classTitle": "<string>",
          "docNumber": "<string>",
          "docNumberQualifier": "<string>",
          "sharesIssued": 123,
          "status": "<string>"
        }
      ],
      "startDate": "2023-12-25",
      "status": {
        "code": "<string>",
        "description": "<string>"
      },
      "subType": {
        "code": "<string>",
        "description": "<string>"
      },
      "subclass": {
        "code": "<string>",
        "description": "<string>"
      },
      "type": {
        "code": "<string>",
        "description": "<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-Background
integer

If this header parameter is supplied and set to 1, then the request will not wait for the process to finish, and will return a 202 if there are no obvious errors in the input. The request will then run in the background and send a notification back to the customer. See out callback API for details on this.

See more details here: https://docs.frankieone.com/docs/asynchronous-calls-backgrounding-processes

Required range: 0 <= x <= 1
​
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.

Path Parameters

​
entityId
string<uuid>
required

The entityId returned previously from an earlier call to /check or /entity

Query Parameters

​
noInvalidate
boolean

Disable check result invalidation for this update request.

Body

application/json

The entity to be updated

Describes all of the data being used to verify an entity.

​
addresses
object[]

Collection of address objects.

​
dateOfBirth
object
​
entityId
string<uuid>

When an entity is first created, it is assigned an ID. When updating an entity, make sure you set the entityId One exception to this is when an entity is created from a document object. It is expected that this object would be passed into a /check or /entity call to set it.

Example:

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

​
entityProfile
string

If the entity is using the new profiles feature, then their profile name will be found here.

Note: If setting a profile, you must ensure that the profile matches a known configuration.

See here for valid values: https://docs.frankieone.com/docs/test-entity-verification

​
entityType
enum<string>

Indicates the type of an entity.

  • "INDIVIDUAL": An individual.
  • "TRUST": A trust.
  • "ORGANISATION": An organisation.
Available options:
INDIVIDUAL,
TRUST,
ORGANISATION
Example:

"ORGANISATION"

​
extraData
object[]

Set of key-value pairs that provide arbitrary additional type-specific data. You can use these fields to store external IDs, or other non-identity related items if you need to. If updating an existing entity, then existing values with the same name will be overwritten. New values will be added.

See here for more information about possible values you can use: https://docs.frankieone.com/docs/key-value-pairs

​
flags
object[]

Used to set additional information flags with regards to this entity and for ongoing processing.

Flags might include having the entity (not) participate in regular pep/sanctions screening Others will follow over time.

​
gender
enum<string>

Used to indicate of the entity in question is:

  • "M"ale
  • "F"emale
  • "U"nspecified
  • "O"ther (for want of a better option)
Available options:
U,
F,
M,
O
Example:

"F"

​
identityDocs
object[]

Collection of identity documents (photos, scans, selfies, etc)

​
name
object
​
organisationData
object

Organisation details for entities. Returned from an ASIC report.

Response

The request was valid and able to be processed in some fashion. Results may or may not be successful, but it was completed as far as practical with no actual errors. Returns the entity object as it stands now. No docScan file data from any attached ID documents will be returned unless the /full variant is requested.

Contains the results of a given document entity create/update or GET request.

​
entity
object
required

Describes all of the data being used to verify an entity.

​
requestId
string<ulid>
required

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"