Document Analysis Result Confirmation

POST

Confirm Document Analysis Results

Path parameters

documentIdstringRequired

Unique identifier for a document

entityIdstringRequired

Unique FrankieOne identifier for an entity

analysisIdstringRequired

An identifier to uniquely identify a specific instance of analysis

Headers

X-Frankie-CustomerIDstringRequired

Your Customer ID provided by FrankieOne

X-Frankie-CustomerChildIDstringOptional

Your Customer Child ID provided by FrankieOne

X-Frankie-ChannelstringOptional

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_keystringRequired

Your API key provided by FrankieOne

Request

This endpoint expects an object.

referencesmap from strings to objectsOptional

documentInformationobjectOptional

Response

requestIdstringOptional

The unique request ID for the API call made.

Release Notes

Up Next

Built with

1	curl -X POST https://api.frankie.one/experimental/v2/organizations/entityId/documents/documentId/analyses/analysisId/confirm \
2	-H "X-Frankie-CustomerID: 12345678-1234-1234-1234-123456789012" \
3	-H "X-Frankie-CustomerChildID: 87654321-4321-4321-4321-210987654321" \
4	-H "api_key: 245c765b124a098d09ef8765...." \
5	-H "Authorization: Bearer <token>" \
6	-H "Content-Type: application/json" \
7	-d '{}'