Developer Guide
Developer Tools
Endpoints
curl --request POST \
--url https://{region}.affinda.com/v2/invoices \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form file='@example-file' \
--form url=https://api.affinda.com/static/sample_invoices/example.pdf \
--form 'identifier=<string>' \
--form 'customIdentifier=<string>' \
--form fileName=Document.pdf \
--form wait=true \
--form rejectDuplicates=true \
--form language=en \
--form expiryTime=2023-11-07T05:31:56Z \
--form 'regionBias={"country": "vn"}' \
--form lowPriority=true{
"clientVerifiedDt": "<string>",
"data": {
"tables": [
{
"rows": [
{
"code": "<string>",
"date": "2022-07-01",
"description": "<string>",
"unit": "<string>",
"unitPrice": 123,
"quantity": 123,
"discount": "<string>",
"baseTotal": 123,
"taxRate": "<string>",
"taxTotal": 123,
"total": 123,
"other": "<string>",
"customFields": {}
}
]
}
],
"invoiceDate": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "2022-02-09"
},
"invoiceOrderDate": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "2022-02-09"
},
"paymentDateDue": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "2022-02-09"
},
"paymentAmountBase": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"paymentAmountTax": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"paymentAmountTotal": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"paymentAmountPaid": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"paymentAmountDue": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"invoiceNumber": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"invoicePurchaseOrderNumber": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"supplierBusinessNumber": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"customerNumber": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"customerBusinessNumber": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"paymentReference": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"bankAccountNumber": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"supplierVat": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"customerVat": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"bpayBillerCode": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"bpayReference": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"bankSortCode": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"bankIban": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"bankSwift": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"bankBsb": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"customerContactName": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"customerCompanyName": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"supplierCompanyName": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"customerBillingAddress": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": {
"rawInput": "Blacksburg, VA",
"formatted": "Blacksburg, VA, USA",
"postalCode": "3124",
"state": "Virginia",
"stateCode": "TX",
"country": "United States",
"countryCode": "US",
"streetNumber": "1",
"street": "Smith St",
"apartmentNumber": "12",
"city": "Blacksburg",
"latitude": "67.0124",
"longitude": "67.0124",
"poBox": "P.O. Box 123"
}
},
"customerDeliveryAddress": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": {
"rawInput": "Blacksburg, VA",
"formatted": "Blacksburg, VA, USA",
"postalCode": "3124",
"state": "Virginia",
"stateCode": "TX",
"country": "United States",
"countryCode": "US",
"streetNumber": "1",
"street": "Smith St",
"apartmentNumber": "12",
"city": "Blacksburg",
"latitude": "67.0124",
"longitude": "67.0124",
"poBox": "P.O. Box 123"
}
},
"supplierAddress": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": {
"rawInput": "Blacksburg, VA",
"formatted": "Blacksburg, VA, USA",
"postalCode": "3124",
"state": "Virginia",
"stateCode": "TX",
"country": "United States",
"countryCode": "US",
"streetNumber": "1",
"street": "Smith St",
"apartmentNumber": "12",
"city": "Blacksburg",
"latitude": "67.0124",
"longitude": "67.0124",
"poBox": "P.O. Box 123"
}
},
"customerPhoneNumber": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"supplierPhoneNumber": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"supplierFax": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"customerEmail": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"supplierEmail": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"supplierWebsite": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"currencyCode": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"customFields": {}
},
"meta": {
"identifier": "<string>",
"customIdentifier": "46ab8b02-0e5b-420c-877c-8b678d46a834",
"fileName": "Document.pdf",
"ready": true,
"readyDt": "2020-12-10T01:43:32.276724Z",
"failed": false,
"expiryTime": "2023-11-07T05:31:56Z",
"language": "en",
"pdf": "https://affinda-api.s3.amazonaws.com/media/documents/Document.pdf?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062",
"parentDocument": {
"identifier": "<string>"
},
"childDocuments": [
{
"identifier": "<string>"
}
],
"pages": [
{
"id": 2,
"pageIndex": 0,
"image": "https://affinda-api.s3.amazonaws.com/media/pages/Page.png?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062",
"height": 700,
"width": 500,
"rotation": 90,
"imageTranslated": "https://affinda-api.s3.amazonaws.com/media/pages/PageTranslated.png?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062"
}
],
"isVerified": false,
"reviewUrl": "https://app.affinda.com/review/XJ5kK123?signature=12345",
"ocrConfidence": 0.97,
"createdDt": "2023-11-07T05:31:56Z",
"documentType": "resume",
"regionBias": {
"country": "<string>",
"countries": [
"<string>"
],
"squareCoordinates": [
123
],
"strict": true
},
"isOcrd": true
},
"error": {
"errorCode": "document_conversion_failed",
"errorDetail": "Unable to convert word document"
}
}Upload an invoice for parsing
Uploads an invoice for parsing.
When successful, returns an identifier in the response for subsequent use with the /invoices/ endpoint to check processing status and retrieve results.
curl --request POST \
--url https://{region}.affinda.com/v2/invoices \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form file='@example-file' \
--form url=https://api.affinda.com/static/sample_invoices/example.pdf \
--form 'identifier=<string>' \
--form 'customIdentifier=<string>' \
--form fileName=Document.pdf \
--form wait=true \
--form rejectDuplicates=true \
--form language=en \
--form expiryTime=2023-11-07T05:31:56Z \
--form 'regionBias={"country": "vn"}' \
--form lowPriority=true{
"clientVerifiedDt": "<string>",
"data": {
"tables": [
{
"rows": [
{
"code": "<string>",
"date": "2022-07-01",
"description": "<string>",
"unit": "<string>",
"unitPrice": 123,
"quantity": 123,
"discount": "<string>",
"baseTotal": 123,
"taxRate": "<string>",
"taxTotal": 123,
"total": 123,
"other": "<string>",
"customFields": {}
}
]
}
],
"invoiceDate": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "2022-02-09"
},
"invoiceOrderDate": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "2022-02-09"
},
"paymentDateDue": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "2022-02-09"
},
"paymentAmountBase": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"paymentAmountTax": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"paymentAmountTotal": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"paymentAmountPaid": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"paymentAmountDue": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"invoiceNumber": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"invoicePurchaseOrderNumber": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"supplierBusinessNumber": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"customerNumber": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"customerBusinessNumber": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"paymentReference": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"bankAccountNumber": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"supplierVat": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"customerVat": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"bpayBillerCode": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"bpayReference": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"bankSortCode": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"bankIban": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"bankSwift": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"bankBsb": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"customerContactName": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"customerCompanyName": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"supplierCompanyName": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"customerBillingAddress": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": {
"rawInput": "Blacksburg, VA",
"formatted": "Blacksburg, VA, USA",
"postalCode": "3124",
"state": "Virginia",
"stateCode": "TX",
"country": "United States",
"countryCode": "US",
"streetNumber": "1",
"street": "Smith St",
"apartmentNumber": "12",
"city": "Blacksburg",
"latitude": "67.0124",
"longitude": "67.0124",
"poBox": "P.O. Box 123"
}
},
"customerDeliveryAddress": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": {
"rawInput": "Blacksburg, VA",
"formatted": "Blacksburg, VA, USA",
"postalCode": "3124",
"state": "Virginia",
"stateCode": "TX",
"country": "United States",
"countryCode": "US",
"streetNumber": "1",
"street": "Smith St",
"apartmentNumber": "12",
"city": "Blacksburg",
"latitude": "67.0124",
"longitude": "67.0124",
"poBox": "P.O. Box 123"
}
},
"supplierAddress": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": {
"rawInput": "Blacksburg, VA",
"formatted": "Blacksburg, VA, USA",
"postalCode": "3124",
"state": "Virginia",
"stateCode": "TX",
"country": "United States",
"countryCode": "US",
"streetNumber": "1",
"street": "Smith St",
"apartmentNumber": "12",
"city": "Blacksburg",
"latitude": "67.0124",
"longitude": "67.0124",
"poBox": "P.O. Box 123"
}
},
"customerPhoneNumber": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"supplierPhoneNumber": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"supplierFax": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"customerEmail": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"supplierEmail": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"supplierWebsite": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"currencyCode": {
"id": 2,
"rectangle": {
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
},
"rectangles": [
{
"x0": 2.43,
"y0": 4.55,
"x1": 4.56,
"y1": 6.32,
"pageIndex": 1
}
],
"pageIndex": 0,
"raw": "<string>",
"confidence": 0.86,
"classificationConfidence": 0.95,
"textExtractionConfidence": 0.9,
"isVerified": true,
"isClientVerified": true,
"isAutoVerified": true,
"contentType": "<string>",
"dataPoint": "<string>",
"parsed": "<string>"
},
"customFields": {}
},
"meta": {
"identifier": "<string>",
"customIdentifier": "46ab8b02-0e5b-420c-877c-8b678d46a834",
"fileName": "Document.pdf",
"ready": true,
"readyDt": "2020-12-10T01:43:32.276724Z",
"failed": false,
"expiryTime": "2023-11-07T05:31:56Z",
"language": "en",
"pdf": "https://affinda-api.s3.amazonaws.com/media/documents/Document.pdf?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062",
"parentDocument": {
"identifier": "<string>"
},
"childDocuments": [
{
"identifier": "<string>"
}
],
"pages": [
{
"id": 2,
"pageIndex": 0,
"image": "https://affinda-api.s3.amazonaws.com/media/pages/Page.png?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062",
"height": 700,
"width": 500,
"rotation": 90,
"imageTranslated": "https://affinda-api.s3.amazonaws.com/media/pages/PageTranslated.png?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062"
}
],
"isVerified": false,
"reviewUrl": "https://app.affinda.com/review/XJ5kK123?signature=12345",
"ocrConfidence": 0.97,
"createdDt": "2023-11-07T05:31:56Z",
"documentType": "resume",
"regionBias": {
"country": "<string>",
"countries": [
"<string>"
],
"squareCoordinates": [
123
],
"strict": true
},
"isOcrd": true
},
"error": {
"errorCode": "document_conversion_failed",
"errorDetail": "Unable to convert word document"
}
}Authorizations
Basic authentication using an API key, e.g. {Authorization: Bearer 75z0bb4fbdf97b7e4111ff6c0015471094155f91}.
You can find your API key within the Settings page of the Affinda web app. You can obtain an API key by signing up for a free trial.
Body
Invoice to upload, either via fileupload or URL to a file
File as binary data blob. Supported formats: PDF, DOC, DOCX, TXT, RTF, HTML, PNG, JPG, TIFF, ODT, XLS, XLSX
URL to download the invoice.
"https://api.affinda.com/static/sample_invoices/example.pdf"
Deprecated in favor of customIdentifier.
Specify a custom identifier for the document if you need one, not required to be unique.
Optional filename of the file
"Document.pdf"
If "true" (default), will return a response only after processing has completed. If "false", will return an empty data object which can be polled at the GET endpoint until processing is complete.
true
If "true", parsing will fail when the uploaded document is duplicate of an existing document, no credits will be consumed. If "false", will parse the document normally whether its a duplicate or not. If not provided, will fallback to the workspace settings.
true
Language code in ISO 639-1 format. Must specify zh-cn or zh-tw for Chinese.
"en"
The date/time in ISO-8601 format when the document will be automatically deleted. Defaults to no expiry.
A JSON representation of the RegionBias object.
"{\"country\": \"vn\"}"
Explicitly mark this document as low priority.
true
Response
Only returned when wait=True, will return the created invoice
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"2022-07-01"
Show child attributes
Show child attributes
x >= 1Show child attributes
Show child attributes
Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
x >= 00
The overall confidence that the model's prediction is correct
0.86
The model's confidence that the text has been classified correctly
0.95
If the document was submitted as an image, this is the confidence that the text in the image has been correctly read by the model.
0.9
"2022-02-09"
Show child attributes
Show child attributes
x >= 1Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
x >= 00
The overall confidence that the model's prediction is correct
0.86
The model's confidence that the text has been classified correctly
0.95
If the document was submitted as an image, this is the confidence that the text in the image has been correctly read by the model.
0.9
"2022-02-09"
Show child attributes
Show child attributes
x >= 1Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
x >= 00
The overall confidence that the model's prediction is correct
0.86
The model's confidence that the text has been classified correctly
0.95
If the document was submitted as an image, this is the confidence that the text in the image has been correctly read by the model.
0.9
"2022-02-09"
Show child attributes
Show child attributes
x >= 1Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
x >= 00
The overall confidence that the model's prediction is correct
0.86
The model's confidence that the text has been classified correctly
0.95
If the document was submitted as an image, this is the confidence that the text in the image has been correctly read by the model.
0.9
Show child attributes
Show child attributes
x >= 1Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
x >= 00
The overall confidence that the model's prediction is correct
0.86
The model's confidence that the text has been classified correctly
0.95
If the document was submitted as an image, this is the confidence that the text in the image has been correctly read by the model.
0.9
Show child attributes
Show child attributes
x >= 1Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
x >= 00
The overall confidence that the model's prediction is correct
0.86
The model's confidence that the text has been classified correctly
0.95
If the document was submitted as an image, this is the confidence that the text in the image has been correctly read by the model.
0.9
Show child attributes
Show child attributes
x >= 1Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
x >= 00
The overall confidence that the model's prediction is correct
0.86
The model's confidence that the text has been classified correctly
0.95
If the document was submitted as an image, this is the confidence that the text in the image has been correctly read by the model.
0.9
Show child attributes
Show child attributes
x >= 1Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
x >= 00
The overall confidence that the model's prediction is correct
0.86
The model's confidence that the text has been classified correctly
0.95
If the document was submitted as an image, this is the confidence that the text in the image has been correctly read by the model.
0.9
Show child attributes
Show child attributes
x >= 1Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
x >= 00
The overall confidence that the model's prediction is correct
0.86
The model's confidence that the text has been classified correctly
0.95
If the document was submitted as an image, this is the confidence that the text in the image has been correctly read by the model.
0.9
Show child attributes
Show child attributes
x >= 1Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
x >= 00
The overall confidence that the model's prediction is correct
0.86
The model's confidence that the text has been classified correctly
0.95
If the document was submitted as an image, this is the confidence that the text in the image has been correctly read by the model.
0.9
Show child attributes
Show child attributes
x >= 1Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
x >= 00
The overall confidence that the model's prediction is correct
0.86
The model's confidence that the text has been classified correctly
0.95
If the document was submitted as an image, this is the confidence that the text in the image has been correctly read by the model.
0.9
Show child attributes
Show child attributes
x >= 1Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
x >= 00
The overall confidence that the model's prediction is correct
0.86
The model's confidence that the text has been classified correctly
0.95
If the document was submitted as an image, this is the confidence that the text in the image has been correctly read by the model.
0.9
Show child attributes
Show child attributes
x >= 1Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
x >= 00
The overall confidence that the model's prediction is correct
0.86
The model's confidence that the text has been classified correctly
0.95
If the document was submitted as an image, this is the confidence that the text in the image has been correctly read by the model.
0.9
Show child attributes
Show child attributes
x >= 1Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
x >= 00
The overall confidence that the model's prediction is correct
0.86
The model's confidence that the text has been classified correctly
0.95
If the document was submitted as an image, this is the confidence that the text in the image has been correctly read by the model.
0.9
Show child attributes
Show child attributes
x >= 1Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
x >= 00
The overall confidence that the model's prediction is correct
0.86
The model's confidence that the text has been classified correctly
0.95
If the document was submitted as an image, this is the confidence that the text in the image has been correctly read by the model.
0.9
Show child attributes
Show child attributes
x >= 1Show child attributes
Show child attributes
Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
x >= 00
The overall confidence that the model's prediction is correct
0.86
The model's confidence that the text has been classified correctly
0.95
If the document was submitted as an image, this is the confidence that the text in the image has been correctly read by the model.
0.9
Show child attributes
Show child attributes
x >= 1Show child attributes
Show child attributes
Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
x >= 00
The overall confidence that the model's prediction is correct
0.86
The model's confidence that the text has been classified correctly
0.95
If the document was submitted as an image, this is the confidence that the text in the image has been correctly read by the model.
0.9
Show child attributes
Show child attributes
x >= 1Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
x >= 00
The overall confidence that the model's prediction is correct
0.86
The model's confidence that the text has been classified correctly
0.95
If the document was submitted as an image, this is the confidence that the text in the image has been correctly read by the model.
0.9
Show child attributes
Show child attributes
x >= 1Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
x >= 00
The overall confidence that the model's prediction is correct
0.86
The model's confidence that the text has been classified correctly
0.95
If the document was submitted as an image, this is the confidence that the text in the image has been correctly read by the model.
0.9
Show child attributes
Show child attributes
x >= 1Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
x >= 00
The overall confidence that the model's prediction is correct
0.86
The model's confidence that the text has been classified correctly
0.95
If the document was submitted as an image, this is the confidence that the text in the image has been correctly read by the model.
0.9
Show child attributes
Show child attributes
x >= 1Show child attributes
Show child attributes
Show child attributes
Show child attributes
x >= 00
The overall confidence that the model's prediction is correct
0.86
The model's confidence that the text has been classified correctly
0.95
If the document was submitted as an image, this is the confidence that the text in the image has been correctly read by the model.
0.9
Show child attributes
Show child attributes
x >= 1Show child attributes
Show child attributes
Show child attributes
Show child attributes
x >= 00
The overall confidence that the model's prediction is correct
0.86
The model's confidence that the text has been classified correctly
0.95
If the document was submitted as an image, this is the confidence that the text in the image has been correctly read by the model.
0.9
Show child attributes
Show child attributes
x >= 1Show child attributes
Show child attributes
Show child attributes
Show child attributes
x >= 00
The overall confidence that the model's prediction is correct
0.86
The model's confidence that the text has been classified correctly
0.95
If the document was submitted as an image, this is the confidence that the text in the image has been correctly read by the model.
0.9
Show child attributes
Show child attributes
x >= 1Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
x >= 00
The overall confidence that the model's prediction is correct
0.86
The model's confidence that the text has been classified correctly
0.95
If the document was submitted as an image, this is the confidence that the text in the image has been correctly read by the model.
0.9
Show child attributes
Show child attributes
x >= 1Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
x >= 00
The overall confidence that the model's prediction is correct
0.86
The model's confidence that the text has been classified correctly
0.95
If the document was submitted as an image, this is the confidence that the text in the image has been correctly read by the model.
0.9
Show child attributes
Show child attributes
x >= 1Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
x >= 00
The overall confidence that the model's prediction is correct
0.86
The model's confidence that the text has been classified correctly
0.95
If the document was submitted as an image, this is the confidence that the text in the image has been correctly read by the model.
0.9
Show child attributes
Show child attributes
x >= 1Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
x >= 00
The overall confidence that the model's prediction is correct
0.86
The model's confidence that the text has been classified correctly
0.95
If the document was submitted as an image, this is the confidence that the text in the image has been correctly read by the model.
0.9
Show child attributes
Show child attributes
"Blacksburg, VA"
"Blacksburg, VA, USA"
"3124"
"Virginia"
"TX"
"United States"
Two letter country code (ISO 3166-1 alpha-2)
"US"
"1"
"Smith St"
"12"
"Blacksburg"
"67.0124"
"67.0124"
"P.O. Box 123"
Show child attributes
Show child attributes
x >= 1Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
x >= 00
The overall confidence that the model's prediction is correct
0.86
The model's confidence that the text has been classified correctly
0.95
If the document was submitted as an image, this is the confidence that the text in the image has been correctly read by the model.
0.9
Show child attributes
Show child attributes
"Blacksburg, VA"
"Blacksburg, VA, USA"
"3124"
"Virginia"
"TX"
"United States"
Two letter country code (ISO 3166-1 alpha-2)
"US"
"1"
"Smith St"
"12"
"Blacksburg"
"67.0124"
"67.0124"
"P.O. Box 123"
Show child attributes
Show child attributes
x >= 1Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
x >= 00
The overall confidence that the model's prediction is correct
0.86
The model's confidence that the text has been classified correctly
0.95
If the document was submitted as an image, this is the confidence that the text in the image has been correctly read by the model.
0.9
Show child attributes
Show child attributes
"Blacksburg, VA"
"Blacksburg, VA, USA"
"3124"
"Virginia"
"TX"
"United States"
Two letter country code (ISO 3166-1 alpha-2)
"US"
"1"
"Smith St"
"12"
"Blacksburg"
"67.0124"
"67.0124"
"P.O. Box 123"
Show child attributes
Show child attributes
x >= 1Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
x >= 00
The overall confidence that the model's prediction is correct
0.86
The model's confidence that the text has been classified correctly
0.95
If the document was submitted as an image, this is the confidence that the text in the image has been correctly read by the model.
0.9
Show child attributes
Show child attributes
x >= 1Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
x >= 00
The overall confidence that the model's prediction is correct
0.86
The model's confidence that the text has been classified correctly
0.95
If the document was submitted as an image, this is the confidence that the text in the image has been correctly read by the model.
0.9
Show child attributes
Show child attributes
x >= 1Show child attributes
Show child attributes
Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
x >= 00
The overall confidence that the model's prediction is correct
0.86
The model's confidence that the text has been classified correctly
0.95
If the document was submitted as an image, this is the confidence that the text in the image has been correctly read by the model.
0.9
Show child attributes
Show child attributes
x >= 1Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
x >= 00
The overall confidence that the model's prediction is correct
0.86
The model's confidence that the text has been classified correctly
0.95
If the document was submitted as an image, this is the confidence that the text in the image has been correctly read by the model.
0.9
Show child attributes
Show child attributes
x >= 1Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
x >= 00
The overall confidence that the model's prediction is correct
0.86
The model's confidence that the text has been classified correctly
0.95
If the document was submitted as an image, this is the confidence that the text in the image has been correctly read by the model.
0.9
Show child attributes
Show child attributes
x >= 1Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
x >= 00
The overall confidence that the model's prediction is correct
0.86
The model's confidence that the text has been classified correctly
0.95
If the document was submitted as an image, this is the confidence that the text in the image has been correctly read by the model.
0.9
Show child attributes
Show child attributes
x >= 1Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
Show child attributes
Show child attributes
2.43
4.55
4.56
6.32
x >= 01
x >= 00
The overall confidence that the model's prediction is correct
0.86
The model's confidence that the text has been classified correctly
0.95
If the document was submitted as an image, this is the confidence that the text in the image has been correctly read by the model.
0.9
Show child attributes
Show child attributes
Unique identifier for the document
Optional identifier for the document that you can set to track the document in the Affinda system. Is not required to be unique.
"46ab8b02-0e5b-420c-877c-8b678d46a834"
Optional filename of the file
"Document.pdf"
If true, the document has finished processing. Particularly useful if an endpoint request specified wait=False, when polling use this variable to determine when to stop polling
true
The datetime when the document was ready
"2020-12-10T01:43:32.276724Z"
If true, some exception was raised during processing. Check the 'error' field of the main return object.
false
The date/time in ISO-8601 format when the document will be automatically deleted. Defaults to no expiry.
The document's language.
"en"
The URL to the document's pdf (if the uploaded document is not already pdf, it's converted to pdf as part of the parsing process).
"https://affinda-api.s3.amazonaws.com/media/documents/Document.pdf?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062"
The document's pages.
Show child attributes
Show child attributes
x >= 1Page number within the document, starts from 0.
x >= 00
The URL to the image of the page.
"https://affinda-api.s3.amazonaws.com/media/pages/Page.png?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062"
Height of the page's image in px.
700
Width of the page's image in px.
500
The degree of rotation applied to the page. Greater than 0 indicates clockwise rotation. Less than 0 indicates counter-clockwise rotation.
-360 <= x <= 36090
The URL to the translated image of the page.
"https://affinda-api.s3.amazonaws.com/media/pages/PageTranslated.png?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062"
This is true if the 'confirm' button has been clicked in the Affinda validation tool
false
Signed URL (valid for 60 minutes) to access the validation tool. Not applicable for documents types such a resumes.
"https://app.affinda.com/review/XJ5kK123?signature=12345"
The overall confidence in the conversion of image to text. (only applicable for images or PDF documents without a text layer)
0.97
"resume"
Show child attributes
Show child attributes
A single alpha-2 country code (e.g. AU) used by google geocoding service
A list of alpha-2 country codes used by Pelias
A list of coordinates used by Pelias in the shape of [min_lon, min_lat, max_lon, max_lat]
If true, the location must be within the region, as opposed to prefering locations within the region. Default to false.
true