Yomio REST API

Use the OpenAPI reference for current client routes and the v3 document endpoint for new scans.

The OpenAPI reference lists the current client-facing routes, including routes that Yomio keeps for older clients.

Open Swagger UIOpen OpenAPI JSON

Authentication

Authenticated routes use a Yomio Cognito access token in the Authorization header. Send it as Bearer YOUR_ACCESS_TOKEN.

This release does not provide developer API keys or third-party OAuth credentials. Requests use the signed-in Yomio account and follow its normal scan quota.

Scan a receipt

Send a multipart request to POST /api/v3/documents. Use the field name document for the file. The endpoint returns a document ID with a processing status.

curl --request POST \
  --url https://api.yomio.app/api/v3/documents \
  --header "Authorization: Bearer $YOMIO_ACCESS_TOKEN" \
  --form "document=@receipt.jpg" \
  --form "documentType=receipt" \
  --form "transactionType=EXPENSE"

The server responds with HTTP 202 Accepted and a document.id. Poll the status route until processing finishes.

curl --url https://api.yomio.app/api/v3/documents/DOCUMENT_ID/status \
  --header "Authorization: Bearer $YOMIO_ACCESS_TOKEN"

Upload options

  • documentType accepts receipt, invoice, or other.
  • transactionType accepts EXPENSE or INCOME.
  • timezone accepts a time zone name such as Europe/Berlin.
  • pipeline accepts v1 or v2. The default is v1.
  • Files must be 10 MiB or smaller. PDF page count follows the API configuration.

Invoice and other document scans use the same authenticated account and quota rules as receipt scans. The status response includes the resulting expense when processing completes and one is created.

Route reference

Use Swagger UI to inspect request fields, responses, auth requirements, and compatibility routes. New integrations should use the v3 scan route instead of the legacy synchronous document routes.