v1

latestOpenAPI 3.0.3MIT2026-07-22153276289.7 KB

Invoice Extractor

Get list of all invoices

Returns all the invoice summaries for that user, limited to 300 per page.

get/v2/invoices

Query parameters

offsetinteger

The number of documents to skip before starting to collect the result set.

limitinteger

Example:20

The numbers of results to return.

custom_identifierstring

Filter for documents with this custom identifier.

Response

All invoices for user

countinteger required

Number of items in results.

nextstring nullable

URL to request next page of results.

previousstring nullable

URL to request previous page of results.

Example response

{
  "count": 10,
  "results": [
    {
      "customIdentifier": "46ab8b02-0e5b-420c-877c-8b678d46a834",
      "fileName": "Document.pdf",
      "ready": true,
      "readyDt": "2020-12-10T01:43:32.276724Z",
      "language": "en",
      "pdf": "https://affinda-api.s3.amazonaws.com/media/documents/Document.pdf?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062",
      "parentDocument": {
        "identifier": "mEFayXdO"
      },
      "childDocuments": [
        {
          "identifier": "mEFayXdO"
        }
      ],
      "pages": [
        {
          "image": "https://affinda-api.s3.amazonaws.com/media/pages/Page.png?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062",
          "imageTranslated": "https://affinda-api.s3.amazonaws.com/media/pages/PageTranslated.png?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062",
          "height": 700,
          "width": 500,
          "rotation": 90
        }
      ],
      "reviewUrl": "https://app.affinda.com/review/XJ5kK123?signature=12345",
      "ocrConfidence": 0.97,
      "documentType": "resume",
      "regionBias": {
        "strict": true
      }
    }
  ]
}