OCR a PDF or Image File

API Basics

Pay In Endpoints

MoneyIn
Subscription
TokenStorage
Invoice
LineItem
PaymentLink
PaymentMethodDomain
HostedPaymentPages
Cloud
Wallet: Apple Pay

Pay Out Endpoints

MoneyOut
Bill

Pay Ops Endpoints

Templates
Boarding
Chargebacks and ACH Returns
Entities
Notification
Query
Statistic
Export
Import

Object Models

Object Model References

POST

Import

ocrDocumentForm

{typeResult}

curl --request POST \
  --url https://api-sandbox.payabli.com/api/Import/ocrDocumentForm/{typeResult} \
  --header 'Content-Type: multipart/form-data' \
  --header 'requestToken: <api-key>'

{
  "isSuccess": true,
  "responseText": "Success",
  "responseCode": 1,
  "responseData": {
    "resultData": {
      "billNumber": "6654477",
      "netAmount": 3000.21,
      "billDate": "2024-02-01T00:00:00",
      "dueDate": "2024-02-01T00:00:00",
      "comments": null,
      "billItems": [
        {
          "itemTotalAmount": 3000,
          "itemTaxAmount": 0,
          "itemTaxRate": 0,
          "itemProductCode": null,
          "itemProductName": "Paper Airplane Stock",
          "itemDescription": "",
          "itemCommodityCode": null,
          "itemUnitOfMeasure": null,
          "itemCost": 3,
          "itemQty": 1000,
          "itemMode": null,
          "itemCategories": []
        }
      ],
      "mode": 0,
      "accountingField1": null,
      "accountingField2": "VBGEB-45841",
      "additionalData": {
        "category": "Job Supplies",
        "currency_code": "USD",
        "type": "invoice",
        "reference_number": "VBGEB-45841"
      },
      "vendor": {
        "vendorNumber": null,
        "name1": "Paul's Paper Supply",
        "name2": "Paul's Paper Supply Company",
        "ein": null,
        "phone": "970-222-2121",
        "email": null,
        "address1": "123 North 1st St",
        "address2": null,
        "city": null,
        "state": null,
        "zip": null,
        "country": null,
        "mcc": null,
        "locationCode": null,
        "contacts": null,
        "billingData": {
          "id": 0,
          "bankName": "",
          "routingAccount": "",
          "accountNumber": "",
          "typeAccount": "",
          "bankAccountHolderName": "",
          "bankAccountHolderType": "Business",
          "bankAccountFunction": 0
        },
        "paymentMethod": null,
        "vendorStatus": 1,
        "remitAddress1": null,
        "remitAddress2": null,
        "remitCity": null,
        "remitState": null,
        "remitZip": null,
        "remitCountry": null,
        "payeeName1": null,
        "payeeName2": null,
        "customerVendorAccount": null,
        "internalReferenceId": null,
        "customField1": null,
        "customField2": null,
        "additionalData": {
          "web": "www.paulspaper.com"
        }
      },
      "endDate": null,
      "frequency": null,
      "terms": null,
      "status": 0,
      "lotNumber": null,
      "attachments": [
        {
          "ftype": "pdf",
          "filename": "paulsPaper_sample Invoice.pdf",
          "fileDescriptor": null,
          "furl": null,
          "fContent": "JVBERi0xLjcNCiW1tbW1DQoxIDAgb2JqDQo8PC9UeXBlL0NhdGFsb2cvUGFnZXMgMiAwIFIvTGFuZyhlbikgL1N0cnVjdFRyZWVSb290IDE4IDAgUi9NYXJrSW5mbzw8L01hcmtlZCB0cnVlPj4vTWV0YWRhdGEgMTg0IDAgUi9WaWV3ZXJQcmVmZXJlbmNlcyAxODUgMCBSPj4NCmVuZG9iag0KMiAwIG9iag0KPDwvVHlwZS9QYWdlcy9Db3VudCAxL0tpZHNbIDMgMCBSXSA..."
        }
      ]
    }
  }
}

Learn how to use our OCR engine to scrape documents and create : Use the OCR Engine

Authorizations

requestToken

string

header

required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

typeResult

string

required

The type of object to create in Payabli. Accepted values are bill and invoice.

Example:

"bill"

Body

multipart/form-data

file

The image file to OCR. Accepted formats:

pdf
jpg
jpeg
png
gif

Response

200 - application/json

Success

isSuccess

boolean

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

Example:

true

responseText

string | null

Response text for operation: 'Success' or 'Declined'.

Example:

"Success"

responseCode

integer | null

Code for the response. Learn more in API Response Codes.

Example:

1

responseData

object | null

Object containing the response data.

responseData.resultData

object

Key-value pairs created from the document's OCR results.

responseData.resultData.scheduledOptions

object | null

Returned when resultType = invoice.

responseData.resultData.customerData

object

Returned with all resultType values.

responseData.resultData.customerData.customerNumber

string | null

User-provided unique identifier for the customer. This is typically the customer ID from your own system.

Maximum length: 250

Example:

"3456-7645A"

responseData.resultData.customerData.customerUsername

string | null

Customer username for customer portal

Example:

"myusername"

responseData.resultData.customerData.customerPsw

string | null

Customer password for customer portal

Example:

"mypassword"

responseData.resultData.customerData.customerStatus

integer | null

Customer Status. Possible values:

-99 Deleted
0 Inactive
1 Active
85 Locked (typically due to multiple failed login attempts)

Example:

1

responseData.resultData.customerData.company

string | null

Company name

Example:

"Sunshine LLC"

responseData.resultData.customerData.firstname

string | null

Customer first name

Example:

"John"

responseData.resultData.customerData.lastname

string | null

Customer last name

Example:

"Smith"

responseData.resultData.customerData.phone

string | null

Customer phone number

Example:

"1234567890"

responseData.resultData.customerData.email

string | null

Customer email address.

Maximum length: 320

Example:

"example@email.com"

responseData.resultData.customerData.address

string | null

Customer address

Example:

"777 Main St"

responseData.resultData.customerData.address1

string | null

Additional customer address

Example:

"Apt 6"

responseData.resultData.customerData.city

string | null

Customer city

Example:

"Miami"

responseData.resultData.customerData.state

string | null

Customer State

Example:

"FL"

responseData.resultData.customerData.zip

string | null

Customer zip code

Example:

"33000"

responseData.resultData.customerData.country

string | null

Customer country in ISO-3166-1 alpha 2 format
See https://en.wikipedia.org/wiki/ISO_3166-1 for reference.

Example:

"US"

responseData.resultData.customerData.shippingAddress

string | null

The shipping address.

Maximum length: 250

Example:

"123 Walnut St"

responseData.resultData.customerData.shippingAddress1

string | null

Additional line for shipping address.

Maximum length: 100

Example:

"STE 900"

responseData.resultData.customerData.shippingCity

string | null

Shipping city.

Maximum length: 250

Example:

"Johnson City"

responseData.resultData.customerData.shippingState

string | null

Shipping state or province.

Example:

"TN"

responseData.resultData.customerData.shippingZip

string | null

Shipping ZIP code.

Maximum length: 50

Example:

"37619"

responseData.resultData.customerData.shippingCountry

string | null

Shipping address country.

Example:

"US"

responseData.resultData.customerData.balance

number | null

Customer balance.

Example:

988.44

responseData.resultData.customerData.timeZone

integer | null

default:0

Timezone, in UTC offset. For example, -5 is Eastern time.

Example:

-5

responseData.resultData.customerData.additionalFields

object | null

Additional Custom fields in format "key":"value".

responseData.resultData.customerData.identifierFields

(string | null)[] | null

List of fields acting as customer identifiers, to be used instead of CustomerNumber.

Example:

["email"]

responseData.resultData.customerData.createdAt

string

Timestamp of when record was created, in UTC.

Example:

"2022-07-01 15:00:01"

responseData.resultData.invoiceData

object

Returned when resultType = invoice.

responseData.resultData.invoiceData.customerData

object

Object describing the customer/payor. Required for POST requests. Which fields are required depends on the paypoint's custom identifier settings. See PayorData Object Model for a complete reference.

responseData.resultData.invoiceData.customerData.customerId

integer | null

The Payabli-generated unique ID for the customer.

Example:

4440

responseData.resultData.invoiceData.customerData.firstName

string | null

Customer/Payor first name.

Maximum length: 250

Example:

"John"

responseData.resultData.invoiceData.customerData.lastName

string | null

Customer/Payor last name.

Maximum length: 250

Example:

"Doe"

responseData.resultData.invoiceData.customerData.company

string | null

Customer's company name.

Maximum length: 250

Example:

"Sunshine LLC"

responseData.resultData.invoiceData.customerData.customerNumber

string | null

User-provided unique identifier for the customer. This is typically the customer ID from your own system.

Maximum length: 250

Example:

"3456-7645A"

responseData.resultData.invoiceData.customerData.billingAddress1

string | null

Customer's billing address.

Maximum length: 250

Example:

"123 Walnut Street"

responseData.resultData.invoiceData.customerData.billingAddress2

string | null

Additional line for Customer's billing address.

Maximum length: 100

Example:

"STE 900"

responseData.resultData.invoiceData.customerData.billingCity

string | null

Customer's billing city.

Maximum length: 250

Example:

"Johnson City"

responseData.resultData.invoiceData.customerData.billingState

string | null

Customer's billing state. Must be 2-letter state code for address in US.

Maximum length: 250

Example:

"Johnson City"

responseData.resultData.invoiceData.customerData.billingZip

string | null

Customer's billing ZIP code.

Maximum length: 50

Example:

"37615"

responseData.resultData.invoiceData.customerData.billingCountry

string | null

Customer's billing country.

Maximum length: 100

Example:

"US"

responseData.resultData.invoiceData.customerData.billingPhone

string | null

Customer's phone number.

Maximum length: 50

Example:

"5555555555"

responseData.resultData.invoiceData.customerData.billingEmail

string | null

Customer's email address.

Maximum length: 320

Example:

"example@email.com"

responseData.resultData.invoiceData.customerData.shippingAddress1

string | null

The shipping address.

Maximum length: 250

Example:

"123 Walnut St"

responseData.resultData.invoiceData.customerData.shippingAddress2

string | null

Additional line for shipping address.

Maximum length: 100

Example:

"STE 900"

responseData.resultData.invoiceData.customerData.shippingCity

string | null

Shipping city.

Maximum length: 250

Example:

"Johnson City"

responseData.resultData.invoiceData.customerData.shippingState

string | null

Shipping state or province.

Example:

"TN"

responseData.resultData.invoiceData.customerData.shippingZip

string | null

Shipping ZIP code.

Maximum length: 50

Example:

"37619"

responseData.resultData.invoiceData.customerData.shippingCountry

string | null

Shipping address country.

Maximum length: 100

Example:

"US"

responseData.resultData.invoiceData.customerData.additionalData

object

Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. If you are using custom identifiers, pass those in this object. Example usage:

{
  "additionalData": {
    "CustomIdentifier": "value",
    "key2": "value2",
    "key3": "value3"
  }
}

Example:

{
  "key1": "value1",
  "key2": "value2",
  "key3": "value3"
}

responseData.resultData.invoiceData.customerData.identifierFields

(string | null)[] | null

List of fields acting as customer identifiers, to be used instead of CustomerNumber.

Example:

["email"]

responseData.resultData.invoiceData.invoiceData

object

Object describing the invoice. Required for POST requests.

responseData.resultData.invoiceData.invoiceData.invoiceNumber

string | null

Invoice number. Identifies the invoice under a paypoint.

Maximum length: 250

Example:

"INV-2345"

responseData.resultData.invoiceData.invoiceData.invoiceDate

string | null

Invoice date in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.

Example:

"2024-07-01"

responseData.resultData.invoiceData.invoiceData.invoiceDueDate

string | null

Invoice due date in one of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.

Example:

"2024-07-01"

responseData.resultData.invoiceData.invoiceData.invoiceType

integer | null

Type of invoice. Only 0 for one-time invoices is currently supported.

Example:

0

responseData.resultData.invoiceData.invoiceData.invoiceEndDate

string | null

Indicate the date to finish a scheduled invoice cycle (`invoiceType`` = 1) in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.

Example:

"2024-07-01"

responseData.resultData.invoiceData.invoiceData.invoiceStatus

enum<integer> | null

Status for invoice.

The accepted status values are:

0 draft
1 active
2 partially paid
4 paid/complete
99 cancelled

Available options:

0,

1,

2,

4,

99

Example:

1

responseData.resultData.invoiceData.invoiceData.frequency

enum<string> | null

Frequency of scheduled invoice.

Available options:

one-time,

weekly,

every2weeks,

every6months,

monthly,

every3months,

annually

Example:

"monthly"

responseData.resultData.invoiceData.invoiceData.paymentTerms

enum<string> | null

Payment terms for invoice. If no terms are defined, then reponse data for this field defaults to N30.

Available options:

PIA,

CIA,

UR,

NET10,

NET20,

NET30,

NET45,

NET60,

NET90,

EOM,

MFI,

5MFI,

10MFI,

15MFI,

20MFI,

2/10NET30,

UF,

10UF,

20UF,

25UF,

50UF

Example:

"PIA"

responseData.resultData.invoiceData.invoiceData.termsConditions

string | null

Custom terms and conditions included in the invoice.

Example:

"Must be paid before work scheduled."

responseData.resultData.invoiceData.invoiceData.notes

string | null

Notes included in the invoice.

Example:

"Example notes."

responseData.resultData.invoiceData.invoiceData.tax

number | null

Tax rate in percent applied to the invoice.

Example:

2.05

responseData.resultData.invoiceData.invoiceData.discount

number | null

Discount applied to the invoice.

Example:

10

responseData.resultData.invoiceData.invoiceData.invoiceAmount

number | null

Invoice total amount.

Example:

105

responseData.resultData.invoiceData.invoiceData.freightAmount

number | null

Freight/shipping amount.

Example:

10

responseData.resultData.invoiceData.invoiceData.dutyAmount

number | null

Duty amount.

Example:

0

responseData.resultData.invoiceData.invoiceData.purchaseOrder

string | null

Purchase order number.

Example:

"PO-345"

responseData.resultData.invoiceData.invoiceData.firstName

string | null

First name of the recipient of the invoice.

Example:

"Chad"

responseData.resultData.invoiceData.invoiceData.lastName

string | null

Last name of the recipient of the invoice.

Example:

"Mercia"

responseData.resultData.invoiceData.invoiceData.company

string | null

Company name of the recipient of the invoice.

Example:

"ACME, INC"

responseData.resultData.invoiceData.invoiceData.shippingAddress1

string | null

The shipping address.

Maximum length: 250

Example:

"123 Walnut St"

responseData.resultData.invoiceData.invoiceData.shippingAddress2

string | null

Additional line for shipping address.

Maximum length: 100

Example:

"STE 900"

responseData.resultData.invoiceData.invoiceData.shippingCity

string | null

Shipping city.

Maximum length: 250

Example:

"Johnson City"

responseData.resultData.invoiceData.invoiceData.shippingState

string | null

Shipping state or province.

Example:

"TN"

responseData.resultData.invoiceData.invoiceData.shippingZip

string | null

Shipping ZIP code.

Maximum length: 50

Example:

"37619"

responseData.resultData.invoiceData.invoiceData.shippingCountry

string | null

Shipping address country.

Example:

"US"

responseData.resultData.invoiceData.invoiceData.shippingEmail

string | null

Shipping recipient's contact email address.

Maximum length: 320

Example:

"example@email.com"

responseData.resultData.invoiceData.invoiceData.shippingPhone

string | null

Recipient phone number.

Example:

"5555555555"

responseData.resultData.invoiceData.invoiceData.shippingFromZip

string | null

Sender shipping ZIP code.

Example:

"30040"

responseData.resultData.invoiceData.invoiceData.summaryCommodityCode

string | null

Commodity code.

Example:

"501718"

responseData.resultData.invoiceData.invoiceData.items

object[] | null

Array of line items included in the invoice.

responseData.resultData.invoiceData.invoiceData.attachments

object | null

Array of fileContent objects with attached documents. Max upload size is 30 MB.

responseData.resultData.invoiceData.invoiceData.AdditionalData

string | null

Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. Example usage:

{
  "additionalData": {
    "key1": "value1",
    "key2": "value2",
    "key3": "value3"
  }
}

Example:

{
  "key1": "value1",
  "key2": "value2",
  "key3": "value3"
}

responseData.resultData.invoiceData.scheduledOptions

object

Object with options for scheduled invoices.

responseData.resultData.billNumber

string | null

Returned when resultType = bill

Example:

"7463"

responseData.resultData.netAmount

string | null

Returned when resultType = bill

Example:

543.09

responseData.resultData.billDate

string | null

Returned when resultType = bill

Example:

"2025-10-19T00:00:00"

responseData.resultData.dueDate

string | null

Returned when resultType = bill

Example:

"2023-03-26T00:00:00"

responseData.resultData.comments

string | null

Returned when resultType = bill

Maximum length: 250

Example:

"Deposit for materials"

responseData.resultData.billItems

object[] | null

Returned when resultType = bill

responseData.resultData.mode

integer

Returned when resultType = bill

Example:

0

responseData.resultData.accountingField1

string | null

Returned when resultType = bill

Example:

"MyInternalId"

responseData.resultData.accountingField2

string | null

Returned when resultType = bill

Example:

"MyInternalId"

responseData.resultData.additionalData

object | null

responseData.resultData.endDate

string | null

Returned when resultType = bill

Example:

"2023-03-26T00:00:00"

responseData.resultData.frequency

string

Returned when resultType = bill

Example:

"monthly"

responseData.resultData.terms

string | null

Returned when resultType = bill

Example:

"NET30"

responseData.resultData.status

integer

Returned when resultType = bill

Example:

0

responseData.resultData.lotNumber

string | null

Returned when resultType = bill

Example:

"VT-3291"

responseData.rawData

object

The raw data from the OCR operation.

responseData.rawData.account_number

null

responseData.rawData.bill_to

object

responseData.rawData.cashback

null

responseData.rawData.category

string

responseData.rawData.created_date

string

responseData.rawData.currency_code

string

responseData.rawData.date

string

responseData.rawData.delivery_date

null

responseData.rawData.discount

null

responseData.rawData.document_reference_number

null

responseData.rawData.document_title

string

responseData.rawData.document_type

string

responseData.rawData.due_date

string

responseData.rawData.duplicate_of

null

responseData.rawData.external_id

null

responseData.rawData.guest_count

null

responseData.rawData.id

integer

responseData.rawData.img_file_name

string

responseData.rawData.insurance

null

responseData.rawData.invoice_number

string

responseData.rawData.is_approved

null

responseData.rawData.is_duplicate

boolean

responseData.rawData.lat

null

responseData.rawData.line_items

object[]

responseData.rawData.lng

null

responseData.rawData.notes

null

responseData.rawData.ocr_text

string

responseData.rawData.order_date

null

responseData.rawData.payment

object

responseData.rawData.purchase_order_number

string

responseData.rawData.rounding

null

responseData.rawData.reference_number

string

responseData.rawData.server_name

null

responseData.rawData.service_end_date

null

responseData.rawData.service_start_date

null

responseData.rawData.ship_date

null

responseData.rawData.ship_to

object

responseData.rawData.shipping

null

responseData.rawData.status

null

responseData.rawData.store_number

null

responseData.rawData.subtotal

integer

responseData.rawData.tax

number

responseData.rawData.tax_lines

object[]

responseData.rawData.timezone_offset

null

responseData.rawData.tip

null

responseData.rawData.total

number

responseData.rawData.total_weight

null

responseData.rawData.tracking_number

null

responseData.rawData.updated_date

string

responseData.rawData.vendor

object

responseData.rawData.weights

null

pageIdentifier

string | null

Auxiliary validation used internally by payment pages and components.

Example:

null

Was this page helpful?

Import List of Customers

OCR a Base64-encoded String

curl --request POST \
  --url https://api-sandbox.payabli.com/api/Import/ocrDocumentForm/{typeResult} \
  --header 'Content-Type: multipart/form-data' \
  --header 'requestToken: <api-key>'

{
  "isSuccess": true,
  "responseText": "Success",
  "responseCode": 1,
  "responseData": {
    "resultData": {
      "billNumber": "6654477",
      "netAmount": 3000.21,
      "billDate": "2024-02-01T00:00:00",
      "dueDate": "2024-02-01T00:00:00",
      "comments": null,
      "billItems": [
        {
          "itemTotalAmount": 3000,
          "itemTaxAmount": 0,
          "itemTaxRate": 0,
          "itemProductCode": null,
          "itemProductName": "Paper Airplane Stock",
          "itemDescription": "",
          "itemCommodityCode": null,
          "itemUnitOfMeasure": null,
          "itemCost": 3,
          "itemQty": 1000,
          "itemMode": null,
          "itemCategories": []
        }
      ],
      "mode": 0,
      "accountingField1": null,
      "accountingField2": "VBGEB-45841",
      "additionalData": {
        "category": "Job Supplies",
        "currency_code": "USD",
        "type": "invoice",
        "reference_number": "VBGEB-45841"
      },
      "vendor": {
        "vendorNumber": null,
        "name1": "Paul's Paper Supply",
        "name2": "Paul's Paper Supply Company",
        "ein": null,
        "phone": "970-222-2121",
        "email": null,
        "address1": "123 North 1st St",
        "address2": null,
        "city": null,
        "state": null,
        "zip": null,
        "country": null,
        "mcc": null,
        "locationCode": null,
        "contacts": null,
        "billingData": {
          "id": 0,
          "bankName": "",
          "routingAccount": "",
          "accountNumber": "",
          "typeAccount": "",
          "bankAccountHolderName": "",
          "bankAccountHolderType": "Business",
          "bankAccountFunction": 0
        },
        "paymentMethod": null,
        "vendorStatus": 1,
        "remitAddress1": null,
        "remitAddress2": null,
        "remitCity": null,
        "remitState": null,
        "remitZip": null,
        "remitCountry": null,
        "payeeName1": null,
        "payeeName2": null,
        "customerVendorAccount": null,
        "internalReferenceId": null,
        "customField1": null,
        "customField2": null,
        "additionalData": {
          "web": "www.paulspaper.com"
        }
      },
      "endDate": null,
      "frequency": null,
      "terms": null,
      "status": 0,
      "lotNumber": null,
      "attachments": [
        {
          "ftype": "pdf",
          "filename": "paulsPaper_sample Invoice.pdf",
          "fileDescriptor": null,
          "furl": null,
          "fContent": "JVBERi0xLjcNCiW1tbW1DQoxIDAgb2JqDQo8PC9UeXBlL0NhdGFsb2cvUGFnZXMgMiAwIFIvTGFuZyhlbikgL1N0cnVjdFRyZWVSb290IDE4IDAgUi9NYXJrSW5mbzw8L01hcmtlZCB0cnVlPj4vTWV0YWRhdGEgMTg0IDAgUi9WaWV3ZXJQcmVmZXJlbmNlcyAxODUgMCBSPj4NCmVuZG9iag0KMiAwIG9iag0KPDwvVHlwZS9QYWdlcy9Db3VudCAxL0tpZHNbIDMgMCBSXSA..."
        }
      ]
    }
  }
}