OCR Platform
Getting Started

Quickstart

Get started with OCR Platform in minutes. Follow these steps to extract your first document.

1

Get your API Key

Sign up or log in to your dashboard to generate an API key.

text
X-API-Key: ds_your_api_key_here
2

Upload your document image

Send your document image to the upload endpoint. Supported formats: JPEG, PNG, WebP.

bash
curl -X POST https://your-domain.com/api/upload \
  -H "X-API-Key: ds_your_api_key" \
  -F "file=@document.jpg"

# Response:
# { "url": "https://storage.example.com/document.jpg" }
3

Extract document data

Use the returned URL to extract data from your document using the appropriate endpoint.

bash
curl -X POST https://your-domain.com/api/mrz/scan \
  -H "X-API-Key: ds_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"imageUrl": "https://storage.example.com/document.jpg"}'
4

Receive structured data

Get validated, structured JSON with all extracted fields and validation status.

json
{
  "requestId": "REQ_abc123",
  "passportNumber": "512345678",
  "surname": "SMITH",
  "givenNames": "JOHN",
  "dateOfBirth": "850101",
  "valid": true,
  "time": 1847
}
IntroductionAuthentication