v1

latestOpenAPI 3.0.3MIT2026-07-22153276289.7 KB
Invoice Extractor

Get parse results for a specific invoice

Returns all the parse results for that invoice if processing is completed. The identifier is the unique ID returned after POST-ing the invoice via the /invoices endpoint.

get/v2/invoices/{identifier}

Path parameters

identifierstring required

A random string that uniquely identify the resource.

Document identifier

Response

Successfully retrieved invoice

clientVerifiedDtstring nullable required

Example response

{
  "data": {
    "tables": [
      {
        "rows": [
          {
            "date": "2022-07-01"
          }
        ]
      }
    ],
    "invoiceDate": {
      "id": 1,
      "rectangle": {
        "pageIndex": 1,
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32
      },
      "rectangles": [
        {
          "pageIndex": 1,
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32
        }
      ],
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9,
      "parsed": "2022-02-09"
    },
    "invoiceOrderDate": {
      "id": 1,
      "rectangle": {
        "pageIndex": 1,
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32
      },
      "rectangles": [
        {
          "pageIndex": 1,
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32
        }
      ],
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9,
      "parsed": "2022-02-09"
    },
    "paymentDateDue": {
      "id": 1,
      "rectangle": {
        "pageIndex": 1,
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32
      },
      "rectangles": [
        {
          "pageIndex": 1,
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32
        }
      ],
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9,
      "parsed": "2022-02-09"
    },
    "paymentAmountBase": {
      "id": 1,
      "rectangle": {
        "pageIndex": 1,
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32
      },
      "rectangles": [
        {
          "pageIndex": 1,
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32
        }
      ],
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9
    },
    "paymentAmountTax": {
      "id": 1,
      "rectangle": {
        "pageIndex": 1,
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32
      },
      "rectangles": [
        {
          "pageIndex": 1,
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32
        }
      ],
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9
    },
    "paymentAmountTotal": {
      "id": 1,
      "rectangle": {
        "pageIndex": 1,
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32
      },
      "rectangles": [
        {
          "pageIndex": 1,
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32
        }
      ],
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9
    },
    "paymentAmountPaid": {
      "id": 1,
      "rectangle": {
        "pageIndex": 1,
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32
      },
      "rectangles": [
        {
          "pageIndex": 1,
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32
        }
      ],
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9
    },
    "paymentAmountDue": {
      "id": 1,
      "rectangle": {
        "pageIndex": 1,
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32
      },
      "rectangles": [
        {
          "pageIndex": 1,
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32
        }
      ],
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9
    },
    "invoiceNumber": {
      "id": 1,
      "rectangle": {
        "pageIndex": 1,
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32
      },
      "rectangles": [
        {
          "pageIndex": 1,
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32
        }
      ],
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9
    },
    "invoicePurchaseOrderNumber": {
      "id": 1,
      "rectangle": {
        "pageIndex": 1,
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32
      },
      "rectangles": [
        {
          "pageIndex": 1,
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32
        }
      ],
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9
    },
    "supplierBusinessNumber": {
      "id": 1,
      "rectangle": {
        "pageIndex": 1,
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32
      },
      "rectangles": [
        {
          "pageIndex": 1,
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32
        }
      ],
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9
    },
    "customerNumber": {
      "id": 1,
      "rectangle": {
        "pageIndex": 1,
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32
      },
      "rectangles": [
        {
          "pageIndex": 1,
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32
        }
      ],
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9
    },
    "customerBusinessNumber": {
      "id": 1,
      "rectangle": {
        "pageIndex": 1,
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32
      },
      "rectangles": [
        {
          "pageIndex": 1,
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32
        }
      ],
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9
    },
    "paymentReference": {
      "id": 1,
      "rectangle": {
        "pageIndex": 1,
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32
      },
      "rectangles": [
        {
          "pageIndex": 1,
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32
        }
      ],
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9
    },
    "bankAccountNumber": {
      "id": 1,
      "rectangle": {
        "pageIndex": 1,
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32
      },
      "rectangles": [
        {
          "pageIndex": 1,
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32
        }
      ],
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9
    },
    "supplierVat": {
      "id": 1,
      "rectangle": {
        "pageIndex": 1,
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32
      },
      "rectangles": [
        {
          "pageIndex": 1,
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32
        }
      ],
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9
    },
    "customerVat": {
      "id": 1,
      "rectangle": {
        "pageIndex": 1,
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32
      },
      "rectangles": [
        {
          "pageIndex": 1,
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32
        }
      ],
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9
    },
    "bpayBillerCode": {
      "id": 1,
      "rectangle": {
        "pageIndex": 1,
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32
      },
      "rectangles": [
        {
          "pageIndex": 1,
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32
        }
      ],
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9
    },
    "bpayReference": {
      "id": 1,
      "rectangle": {
        "pageIndex": 1,
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32
      },
      "rectangles": [
        {
          "pageIndex": 1,
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32
        }
      ],
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9
    },
    "bankSortCode": {
      "id": 1,
      "rectangle": {
        "pageIndex": 1,
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32
      },
      "rectangles": [
        {
          "pageIndex": 1,
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32
        }
      ],
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9
    },
    "bankIban": {
      "id": 1,
      "rectangle": {
        "pageIndex": 1,
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32
      },
      "rectangles": [
        {
          "pageIndex": 1,
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32
        }
      ],
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9
    },
    "bankSwift": {
      "id": 1,
      "rectangle": {
        "pageIndex": 1,
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32
      },
      "rectangles": [
        {
          "pageIndex": 1,
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32
        }
      ],
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9
    },
    "bankBsb": {
      "id": 1,
      "rectangle": {
        "pageIndex": 1,
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32
      },
      "rectangles": [
        {
          "pageIndex": 1,
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32
        }
      ],
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9
    },
    "customerContactName": {
      "id": 1,
      "rectangle": {
        "pageIndex": 1,
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32
      },
      "rectangles": [
        {
          "pageIndex": 1,
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32
        }
      ],
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9
    },
    "customerCompanyName": {
      "id": 1,
      "rectangle": {
        "pageIndex": 1,
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32
      },
      "rectangles": [
        {
          "pageIndex": 1,
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32
        }
      ],
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9
    },
    "supplierCompanyName": {
      "id": 1,
      "rectangle": {
        "pageIndex": 1,
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32
      },
      "rectangles": [
        {
          "pageIndex": 1,
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32
        }
      ],
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9
    },
    "customerBillingAddress": {
      "id": 1,
      "rectangle": {
        "pageIndex": 1,
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32
      },
      "rectangles": [
        {
          "pageIndex": 1,
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32
        }
      ],
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9,
      "parsed": {
        "formatted": "Blacksburg, VA, USA",
        "postalCode": "3124",
        "state": "Virginia",
        "stateCode": "TX",
        "country": "United States",
        "countryCode": "US",
        "rawInput": "Blacksburg, VA",
        "streetNumber": "1",
        "street": "Smith St",
        "apartmentNumber": "12",
        "city": "Blacksburg",
        "poBox": "P.O. Box 123"
      }
    },
    "customerDeliveryAddress": {
      "id": 1,
      "rectangle": {
        "pageIndex": 1,
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32
      },
      "rectangles": [
        {
          "pageIndex": 1,
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32
        }
      ],
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9,
      "parsed": {
        "formatted": "Blacksburg, VA, USA",
        "postalCode": "3124",
        "state": "Virginia",
        "stateCode": "TX",
        "country": "United States",
        "countryCode": "US",
        "rawInput": "Blacksburg, VA",
        "streetNumber": "1",
        "street": "Smith St",
        "apartmentNumber": "12",
        "city": "Blacksburg",
        "poBox": "P.O. Box 123"
      }
    },
    "supplierAddress": {
      "id": 1,
      "rectangle": {
        "pageIndex": 1,
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32
      },
      "rectangles": [
        {
          "pageIndex": 1,
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32
        }
      ],
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9,
      "parsed": {
        "formatted": "Blacksburg, VA, USA",
        "postalCode": "3124",
        "state": "Virginia",
        "stateCode": "TX",
        "country": "United States",
        "countryCode": "US",
        "rawInput": "Blacksburg, VA",
        "streetNumber": "1",
        "street": "Smith St",
        "apartmentNumber": "12",
        "city": "Blacksburg",
        "poBox": "P.O. Box 123"
      }
    },
    "customerPhoneNumber": {
      "id": 1,
      "rectangle": {
        "pageIndex": 1,
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32
      },
      "rectangles": [
        {
          "pageIndex": 1,
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32
        }
      ],
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9
    },
    "supplierPhoneNumber": {
      "id": 1,
      "rectangle": {
        "pageIndex": 1,
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32
      },
      "rectangles": [
        {
          "pageIndex": 1,
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32
        }
      ],
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9
    },
    "supplierFax": {
      "id": 1,
      "rectangle": {
        "pageIndex": 1,
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32
      },
      "rectangles": [
        {
          "pageIndex": 1,
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32
        }
      ],
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9
    },
    "customerEmail": {
      "id": 1,
      "rectangle": {
        "pageIndex": 1,
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32
      },
      "rectangles": [
        {
          "pageIndex": 1,
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32
        }
      ],
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9
    },
    "supplierEmail": {
      "id": 1,
      "rectangle": {
        "pageIndex": 1,
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32
      },
      "rectangles": [
        {
          "pageIndex": 1,
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32
        }
      ],
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9
    },
    "supplierWebsite": {
      "id": 1,
      "rectangle": {
        "pageIndex": 1,
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32
      },
      "rectangles": [
        {
          "pageIndex": 1,
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32
        }
      ],
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9
    },
    "currencyCode": {
      "id": 1,
      "rectangle": {
        "pageIndex": 1,
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32
      },
      "rectangles": [
        {
          "pageIndex": 1,
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32
        }
      ],
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9
    }
  },
  "meta": {
    "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
    }
  },
  "error": {
    "errorCode": "document_conversion_failed",
    "errorDetail": "Unable to convert word document"
  }
}