Skip to content

API Documentation

ConceptsThe Worklayer platformAuthenticationRate LimitsError handling

MemberThe Member ResourceCreate a memberRetrieve a memberRetrieve a member by external IDRetrieve a list of membersUpdate a memberAccept terms for a member

JobsThe Job ResourceRetrieve a job by short IDThe job creation flowThe Info Gathering ChecklistCreate a job from a templateRetrieve questionnaireSubmit questionnaire answersRequest a specific ProRequest a previous ProAssign a supporting clientRemove a supporting clientSubmit a jobRetrieve a list of your jobsList job documentsDelete a jobRetrieve a job checklistComplete info gathering for a jobRequest cancellationRequest reopen

Relationship ManagerRelationship Manager ResourceRetrieve a job relationship manager

Job ProgressionsApprove a draftReject a draftMark job as ready to file

ConsultationsThe Consultation Resource

Scope Change RequestsChange job scopeList consultation service itemsCreate job scope change requestApprove a job scope changeReject a job scope change

Job NotesThe Job Note ResourceCreate a job noteGet a job noteList job notes

Job TemplatesThe Job Template ResourceRetrieve available job templates

Personal ProfilesThe Personal Profile ResourceRetrieve a personal profileSave a personal profileProvide a personal profile to a jobRetrieve a personal profile for a job

Spousal ProfilesThe Spousal Profile ResourceRetrieve a spousal profileSave a spousal profileProvide a spousal profile to a jobRetrieve a spousal profile for a job

Dependent ProfilesThe Dependent Profile ResourceList dependent profilesRetrieve a dependent profileCreate a dependent profileUpdate a dependent profileDelist a dependent profileProvide a dependent profile to a jobRemove a dependent profile from a jobRetrieve dependent profiles for a job

Business ProfilesThe Business Profile ResourceList business profilesCreate a business profileUpdate a business profileRetrieve a business profileRetrieve a business profile for a jobDelist a business profileProvide a business profile to a job

Tax Refund MethodsThe Tax Refund Method ResourceList tax refund methodsCreate a tax refund methodRetrieve a tax refund methodRetrieve a tax refund method for a jobUpdate a tax refund methodDelist a tax refund methodProvide a personal refund methodProvide a business refund method

DocumentsThe Document ResourceCreate a documentGet a documentDownload a documentDelete a document

Document TypesThe Document Type ResourceList document types

MessagesThe Message ResourceSend a messageList messagesGet unread count

OCRStart OCR processingGet OCR results

WebhooksConsume webhook eventsEvent resourcesCheck signatures

Magic LinkDashboardJob DetailsWaitlist

PortalPortal embeddingPortal translations

GuidesFilteringPostman Collection

Start OCR Processing

Initiate OCR processing for a document in your workspace

Note

The OCR API is currently in closed beta.

The start OCR endpoint initiates OCR processing for a document that has been uploaded to a job in your workspace. This is an asynchronous operation that queues the document for processing and returns immediately.

You can either use an existing document in your workspace or create a new document using the Create Documents endpoint, which will return the document_id.

The document must be available for download before OCR processing can start. If file processing or document verification is still in progress, or manual verification is required, this endpoint returns a 409 Conflict response.

After starting OCR processing, use the Get OCR Results endpoint to check the processing status and retrieve the extracted data.

If OCR processing previously failed for a document, calling this endpoint again will automatically retry the process.

Endpoint

Method	Url
`POST`	`/v1.0/ocr/start`

Request Parameters

document_id

•

string

required

The unique identifier of the document to process. This ID is returned when you upload a document using the Create Documents endpoint. The document must already be uploaded to a job in your workspace.

Sample Request

bashCopied
1curl -X POST 'https://api.worklayer.com/v1.0/ocr/start' \
2  -H 'Authorization: Bearer {token}' \
3  -H 'Content-Type: application/json' \
4  -d '{
5    "document_id": "95e6f305-913e-40ad-9c80-ede263670878"
6  }'

Response

The response confirms that OCR processing has been initiated for the specified document.

document_id

•

string

The document ID that was submitted for OCR processing.

Sample Response

jsonCopied
1{
2  "document_id": "95e6f305-913e-40ad-9c80-ede263670878"
3}

Errors

Error Responses

The API returns standard HTTP status codes with descriptive error messages:

Status Code	Error Type	Description
`400`	Bad Request	Invalid document ID format or missing required fields
`401`	Unauthorized	Missing or invalid bearer token
`403`	Forbidden	User lacks permission
`404`	Not Found	Document not found or workspace not found
`409`	Conflict	OCR processing is already in progress or completed for this document
`409`	Conflict	Document is not ready for OCR processing
`500`	Internal Server Error	Error starting OCR processing

Last updated on August 24, 2026

Privacy Policy Terms & Conditions© 2026 Taxfyle