Document Analyze

POST

Begin a Document 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.
entityIdstringOptional

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.

documentIdstringOptional

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

analysisType"TRUST_DOCUMENT"OptionalDefaults to TRUST_DOCUMENT

The type of document analysis to perform

supplementaryInformationobjectOptional

Response

Accepted

entityIdstringOptional

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.

analysisobjectOptional
requestIdstringOptional

The unique request ID for the API call made.

Built with