Skip to main content
POST
/
v2
/
organizations
/
documents
/
analyze
Document Analyze
curl --request POST \
  --url https://api.frankie.one/experimental/v2/organizations/documents/analyze \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api_key>' \
  --data '
{
  "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
  "analysisType": "TRUST_DOCUMENT",
  "supplementaryInformation": {
    "trust": {
      "type": "DISCRETIONARY"
    }
  }
}
'
{
  "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "analysis": {
    "documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
    "status": "PROCESSING",
    "analysisId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "TRUST_DOCUMENT"
  },
  "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...."

Body

application/json
​
entityId
string

Entity's are assigned an auto-generated UUID to ensure global uniqueness, represented as an 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 call.

Example:

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

​
documentId
string<uuid>

As documents are added to an entity, they are assigned a unique identifier to assist with modification and reference. To modify a document, include the documentId in an update request.

Example:

"92de15f64-5717-4562-b3fc-2c963f6665a7"

​
analysisType
enum<string>

The type of document analysis to perform

Available options:
TRUST_DOCUMENT
​
supplementaryInformation
object

Response

Accepted

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

​
analysis
object

Information about the document analysis operation itself.

​
requestId
string

The unique request identifier for the API call made.

Example:

"01HN9XHZN6MGXM9JXG50K59Q85"