Upload Files With OCR

Developing

POST

/api/v1/cdn/upload/ocr

Maintainer:Not configured

Uploads base64-encoded files to the CDN and returns one URL per file, in request order. Images (jpg, jpeg, png, gif, webp) also go through text extraction, but the extracted text is not returned here. A file that fails to upload leaves a null in its position and the response code becomes 99. Not idempotent: each call stores new files.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Request processed. responseCode 00 means every file uploaded; 99 means validation failed or at least one file did not upload.

Bodyapplication/json

🟠400

🟠401

🟠429

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/v1/cdn/upload/ocr' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '[
    {
        "extension": "png",
        "base64String": "iVBORw0KGgoAAAANSUhEUgAAAAUA..."
    },
    {
        "extension": "pdf",
        "base64String": "JVBERi0xLjcKJeLjz9MK..."
    }
]'

Response Example

200 - All files uploaded

{
    "responseCode": "00",
    "responseMessage": "Successful",
    "responseData": [
        "https://cdn.example.com/files/a1b2-133456789.png",
        "https://cdn.example.com/files/c3d4-133456790.pdf"
    ]
}

Modified at 2026-11-09 15:56:33

Nigerian Bank Account Extractor API

Check Assistant Health