OCR — Text Extract
General-purpose OCR — returns the raw text content of any uploaded document image.
Endpoint
POSThttps://gateway.startappz.co.ke/api/v1/sandbox/ocr-extract
Swap sandbox for live once you have production credentials.
Authentication
Send your credentials as headers:
| Header | Value |
|---|---|
X-API-Key | Your public key |
X-API-Secret | Your secret (shown once at issue time) |
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
file |
File (multipart) | required | Any image or PDF. |
Response parameters
All responses follow the standard envelope: { code, message, data }.
| Field | Type | Description |
|---|---|---|
code | String | Internal status code (e.g. 200.001). |
message | String | Human-readable status / error description. |
data | Object | Endpoint-specific payload (fields below). |
data.text |
String | Concatenated extracted text. |
data.confidence |
Float | Average OCR confidence (0–1). |
data.pages |
Integer | Number of pages processed. |
Sandbox masking
By default, sandbox responses mask PII (names, IDs, dates, phone numbers). You can grant unmasked consent per key from your dashboard.