Document Analyze
Begin a Document Analysis
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
This endpoint expects an object.
entityId
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.
documentId
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.
analysisType
The type of document analysis to perform
Allowed values:
supplementaryInformation
Response
Accepted
entityId
Entities are assigned an 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.
analysis
requestId
The unique request identifier for the API call made.