Skip to main content
POST
/
v2
/
organizations
/
{entityId}
/
documents
/
{documentId}
/
analyses
/
{analysisId}
/
confirm
Document Analysis Result Confirmation
curl --request POST \
  --url https://api.kycaml.frankiefinancial.io/experimental/v2/organizations/{entityId}/documents/{documentId}/analyses/{analysisId}/confirm \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api_key>' \
  --data '
{
  "references": {}
}
'
{
  "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

​
analysisId
string
required

An identifier to uniquely identify a specific instance of analysis

Body

application/json

Document information with references

​
references
object
​
documentInformation
object

Response

OK

​
requestId
string

The unique request identifier for the API call made.

Example:

"01HN9XHZN6MGXM9JXG50K59Q85"