v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1413150118.6 KB

Gets summarized results for the StartLendingAnalysis operation, which analyzes text in a lending document. The returned summary consists of information about documents grouped together by a common document type. Information like detected signatures, page numbers, and split documents is returned with respect to the type of grouped document.

You start asynchronous text analysis by calling StartLendingAnalysis, which returns a job identifier (JobId). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to StartLendingAnalysis.

To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetLendingAnalysisSummary, and pass the job identifier (JobId) from the initial call to StartLendingAnalysis.

post/#X-Amz-Target=Textract.GetLendingAnalysisSummary

Headers

X-Amz-Target'Textract.GetLendingAnalysisSummary' required

Request body

JobIdstring required

A unique identifier for the lending or text-detection job. The <code>JobId</code> is returned from StartLendingAnalysis. A <code>JobId</code> value is only valid for 7 days.

Response

Success

JobStatus'IN_PROGRESS' | 'SUCCEEDED' | 'FAILED' | 'PARTIAL_SUCCESS'

The current status of the lending analysis job.

StatusMessagestring

Returns if the lending analysis could not be completed. Contains explanation for what error occurred.

AnalyzeLendingModelVersionstring

The current model version of the Analyze Lending API.