Skip to main content
GET
/
v2
/
organizations
/
{entityId}
/
documents
/
{documentId}
/
analyses
Document Analyses Results
curl --request GET \
  --url https://api.frankiefinancial.io/experimental/v2/organizations/{entityId}/documents/{documentId}/analyses \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api_key>'
{
  "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "analyses": [
    {
      "documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
      "analysisId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "references": {},
      "documentInformation": {
        "type": "TRUST_DOCUMENT",
        "trust": {
          "name": {
            "value": "<string>",
            "referenceIds": [
              "<string>"
            ]
          },
          "establishment": {
            "date": {
              "year": "1990",
              "month": "03",
              "day": "27",
              "unstructured": "12 Rajab 1445 AH",
              "type": "GREGORIAN",
              "normalized": "1990-03-31",
              "referenceIds": [
                "<string>"
              ]
            },
            "country": {
              "value": "<string>",
              "referenceIds": [
                "<string>"
              ]
            },
            "subdivision": {
              "value": "<string>",
              "referenceIds": [
                "<string>"
              ]
            }
          },
          "certification": {
            "date": {
              "year": "1990",
              "month": "03",
              "day": "27",
              "unstructured": "12 Rajab 1445 AH",
              "type": "GREGORIAN",
              "normalized": "1990-03-31",
              "referenceIds": [
                "<string>"
              ]
            }
          },
          "execution": {
            "date": {
              "year": "1990",
              "month": "03",
              "day": "27",
              "unstructured": "12 Rajab 1445 AH",
              "type": "GREGORIAN",
              "normalized": "1990-03-31",
              "referenceIds": [
                "<string>"
              ]
            }
          },
          "linkedIndividuals": {},
          "linkedOrganizations": {},
          "linkedUnknownEntities": {},
          "settlors": [
            {
              "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "referenceIds": [
                "<string>"
              ]
            }
          ],
          "trustees": [
            {
              "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "referenceIds": [
                "<string>"
              ]
            }
          ],
          "type": {},
          "typeInformation": {
            "discretionary": {
              "specifiedBeneficiaries": [
                {
                  "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "referenceIds": [
                    "<string>"
                  ]
                }
              ],
              "generalBeneficiaries": [
                {
                  "value": "<string>",
                  "referenceIds": [
                    "<string>"
                  ]
                }
              ],
              "appointors": [
                {
                  "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "referenceIds": [
                    "<string>"
                  ]
                }
              ],
              "protectors": [
                {
                  "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "referenceIds": [
                    "<string>"
                  ]
                }
              ]
            }
          }
        }
      },
      "errors": [
        {
          "errorCode": "<string>",
          "errorMsg": "<string>",
          "details": [
            {
              "issue": "<string>",
              "issueLocation": "<string>",
              "issueType": "<string>"
            }
          ]
        }
      ]
    }
  ],
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

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

​
api_key
string
required

Your API key provided by FrankieOne

Example:

"245c765b124a098d09ef8765...."

Path Parameters

​
documentId
string
required

Unique identifier for a document

​
entityId
string
required

Unique FrankieOne identifier for an entity

Query Parameters

​
showResults
enum<string>
default:LATEST

Which types of results should be shown The different options for what results should be returned.

  • COMPLETE: Only completed results will be shown.
  • CONFIRMED: Only confirmed results will be shown.
  • LATEST: Only the latest results will be shown (confirmed or completed).
Available options:
COMPLETE,
CONFIRMED,
LATEST

Response

OK

​
entityId
string
read-only

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"

​
analyses
object[]
​
requestId
string

The unique request identifier for the API call made.

Example:

"01HN9XHZN6MGXM9JXG50K59Q85"