Run OCR (Sync)

Deprecated

POST

https://api.mercoa.com/ocr

POST

/ocr

1 from mercoa import Mercoa
2 from mercoa.ocr import OcrRequest
3 
4 client = Mercoa(
5     token="YOUR_TOKEN",
6 )
7 client.ocr.ocr(
8     request=OcrRequest(
9         vendor_network="entity",
10         entity_id="ent_8f86116b-3b4d-4ded-99ef-3bc929d8c33c",
11         mime_type="image/png",
12         image="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAgAAAAIAQMAAAD+wSzIAAAABlBMVEX///+/v7+jQ3Y5AAAADklEQVQI12P4AIX8EAgALgAD/aNpbtEAAAAASUVORK5CYII",
13     ),
14 )

Try it

1 {
2   "jobId": "ocr_8f86116b-3b4d-4ded-99ef-3bc929d8c33c",
3   "invoice": {
4     "approvalPolicy": [],
5     "approvers": [],
6     "createdAt": "2021-01-01T00:00:00Z",
7     "hasDocuments": true,
8     "hasSourceEmail": true,
9     "id": "in_26e7b5d3-a739-4b23-9ad9-6aaa085f47a9",
10     "metadata": {},
11     "paymentDestinationConfirmed": false,
12     "status": "DRAFT",
13     "updatedAt": "2021-01-01T00:00:00Z",
14     "amount": 100,
15     "comments": [],
16     "currency": "USD",
17     "dueDate": "2021-01-31T00:00:00Z",
18     "invoiceDate": "2021-01-01T00:00:00Z",
19     "invoiceNumber": "INV-123",
20     "lineItems": [
21       {
22         "id": "inli_26672f38-eb9a-48f1-a7a0-f1b855e38cd7",
23         "currency": "USD",
24         "category": "EXPENSE",
25         "createdAt": "2021-01-01T00:00:00Z",
26         "updatedAt": "2021-01-01T00:00:00Z",
27         "amount": 100,
28         "description": "Product A",
29         "name": "Product A",
30         "quantity": 1,
31         "unitPrice": 100,
32         "serviceStartDate": "2021-01-01T00:00:00Z",
33         "serviceEndDate": "2021-01-31T00:00:00Z",
34         "metadata": {
35           "key1": "value1",
36           "key2": "value2"
37         },
38         "glAccountId": "600394"
39       }
40     ],
41     "noteToSelf": "For the month of January",
42     "payer": {
43       "acceptedTos": true,
44       "accountType": "business",
45       "createdAt": "2024-01-01T00:00:00Z",
46       "email": "customer@acme.com",
47       "id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
48       "isCustomer": true,
49       "isNetworkPayee": false,
50       "isNetworkPayor": false,
51       "isPayee": false,
52       "isPayor": true,
53       "name": "Acme Inc.",
54       "profile": {
55         "business": {
56           "legalBusinessName": "Acme Inc.",
57           "taxIDProvided": true,
58           "email": "customer@acme.com",
59           "businessType": "llc",
60           "phone": {
61             "countryCode": "1",
62             "number": "4155551234"
63           },
64           "address": {
65             "addressLine1": "123 Main St",
66             "city": "San Francisco",
67             "stateOrProvince": "CA",
68             "postalCode": "94105",
69             "addressLine2": "Unit 1",
70             "country": "US"
71           },
72           "ownersProvided": true,
73           "taxId": {
74             "ein": {
75               "number": "12-3456789"
76             }
77           }
78         }
79       },
80       "status": "verified",
81       "updatedAt": "2024-01-02T00:00:00Z",
82       "accounts": [
83         {
84           "accountId": "85866843",
85           "postalCode": "94105",
86           "nameOnAccount": "John Doe"
87         }
88       ],
89       "counterpartyType": [
90         "ENTITY"
91       ],
92       "foreignId": "MY-DB-ID-12345",
93       "paymentMethods": [
94         {
95           "type": "bankAccount",
96           "accountName": "My Checking Account",
97           "accountNumber": "99988767623",
98           "accountType": "CHECKING",
99           "bankName": "Chase",
100           "createdAt": "2021-01-01T00:00:00Z",
101           "frozen": false,
102           "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
103           "isDefaultDestination": true,
104           "isDefaultSource": true,
105           "metadata": {},
106           "routingNumber": "12345678",
107           "status": "VERIFIED",
108           "supportedCurrencies": [
109             "USD"
110           ],
111           "updatedAt": "2021-01-01T00:00:00Z",
112           "confirmedByEntity": true
113         }
114       ]
115     },
116     "payerId": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
117     "serviceEndDate": "2021-01-31T00:00:00Z",
118     "serviceStartDate": "2021-01-01T00:00:00Z",
119     "vendor": {
120       "acceptedTos": false,
121       "accountType": "business",
122       "createdAt": "2024-01-01T00:00:00Z",
123       "email": "vendor@bigboxstore.com",
124       "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
125       "isCustomer": false,
126       "isNetworkPayee": false,
127       "isNetworkPayor": false,
128       "isPayee": true,
129       "isPayor": false,
130       "name": "Big Box Store",
131       "profile": {
132         "business": {
133           "legalBusinessName": "Big Box Store",
134           "taxIDProvided": false,
135           "email": "vendor@bigboxstore.com",
136           "businessType": "publicCorporation",
137           "ownersProvided": false
138         }
139       },
140       "status": "unverified",
141       "updatedAt": "2024-01-02T00:00:00Z",
142       "counterpartyType": [
143         "ENTITY"
144       ],
145       "foreignId": "MY-DB-ID-90909",
146       "paymentMethods": [
147         {
148           "type": "bankAccount",
149           "accountName": "Vendor Checking Account",
150           "accountNumber": "55934059697648",
151           "accountType": "CHECKING",
152           "bankName": "Chase",
153           "createdAt": "2021-01-01T00:00:00Z",
154           "frozen": false,
155           "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
156           "isDefaultDestination": true,
157           "isDefaultSource": true,
158           "metadata": {},
159           "routingNumber": "66554433",
160           "status": "NEW",
161           "supportedCurrencies": [
162             "USD"
163           ],
164           "updatedAt": "2021-01-01T00:00:00Z",
165           "confirmedByEntity": false
166         }
167       ]
168     },
169     "vendorId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d"
170   },
171   "vendor": {
172     "acceptedTos": false,
173     "accountType": "business",
174     "createdAt": "2024-01-01T00:00:00Z",
175     "email": "vendor@bigboxstore.com",
176     "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
177     "isCustomer": false,
178     "isNetworkPayee": false,
179     "isNetworkPayor": false,
180     "isPayee": true,
181     "isPayor": false,
182     "name": "Big Box Store",
183     "profile": {
184       "business": {
185         "legalBusinessName": "Big Box Store",
186         "taxIDProvided": false,
187         "email": "vendor@bigboxstore.com",
188         "businessType": "publicCorporation",
189         "ownersProvided": false
190       }
191     },
192     "status": "unverified",
193     "updatedAt": "2024-01-02T00:00:00Z",
194     "counterpartyType": [
195       "ENTITY"
196     ],
197     "foreignId": "MY-DB-ID-90909",
198     "paymentMethods": [
199       {
200         "type": "bankAccount",
201         "accountName": "Vendor Checking Account",
202         "accountNumber": "55934059697648",
203         "accountType": "CHECKING",
204         "bankName": "Chase",
205         "createdAt": "2021-01-01T00:00:00Z",
206         "frozen": false,
207         "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
208         "isDefaultDestination": true,
209         "isDefaultSource": true,
210         "metadata": {},
211         "routingNumber": "66554433",
212         "status": "NEW",
213         "supportedCurrencies": [
214           "USD"
215         ],
216         "updatedAt": "2021-01-01T00:00:00Z",
217         "confirmedByEntity": false
218       }
219     ]
220   },
221   "check": {
222     "addressLine1": "123 Main St",
223     "city": "New York",
224     "country": "US",
225     "createdAt": "2021-01-01T00:00:00Z",
226     "frozen": false,
227     "id": "pm_5fde2f4a-facc-48ef-8f0d-6b7d087c7b18",
228     "isDefaultDestination": true,
229     "isDefaultSource": false,
230     "metadata": {},
231     "payToTheOrderOf": "John Doe",
232     "postalCode": "10001",
233     "stateOrProvince": "NY",
234     "supportedCurrencies": [
235       "USD"
236     ],
237     "updatedAt": "2021-01-01T00:00:00Z",
238     "addressLine2": "Apt 1",
239     "confirmedByEntity": true
240   },
241   "bankAccount": {
242     "accountName": "Vendor Checking Account",
243     "accountNumber": "55934059697648",
244     "accountType": "CHECKING",
245     "bankName": "Chase",
246     "createdAt": "2021-01-01T00:00:00Z",
247     "frozen": false,
248     "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
249     "isDefaultDestination": true,
250     "isDefaultSource": true,
251     "metadata": {},
252     "routingNumber": "66554433",
253     "status": "NEW",
254     "supportedCurrencies": [
255       "USD"
256     ],
257     "updatedAt": "2021-01-01T00:00:00Z",
258     "confirmedByEntity": false
259   },
260   "payer": {
261     "id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
262     "name": "Acme Inc.",
263     "email": "customer@acme.com",
264     "isCustomer": true,
265     "accountType": "business",
266     "profile": {
267       "business": {
268         "legalBusinessName": "Acme Inc.",
269         "taxIDProvided": true,
270         "email": "customer@acme.com",
271         "businessType": "llc",
272         "phone": {
273           "countryCode": "1",
274           "number": "4155551234"
275         },
276         "address": {
277           "addressLine1": "123 Main St",
278           "city": "San Francisco",
279           "stateOrProvince": "CA",
280           "postalCode": "94105",
281           "addressLine2": "Unit 1",
282           "country": "US"
283         },
284         "ownersProvided": true,
285         "taxId": {
286           "ein": {
287             "number": "12-3456789"
288           }
289         }
290       }
291     },
292     "status": "verified",
293     "acceptedTos": true,
294     "isPayor": true,
295     "isPayee": false,
296     "isNetworkPayor": false,
297     "isNetworkPayee": false,
298     "createdAt": "2024-01-01T00:00:00Z",
299     "updatedAt": "2024-01-02T00:00:00Z",
300     "foreignId": "MY-DB-ID-12345"
301   }
302 }

Run OCR on an Base64 encoded image or PDF. This endpoint will block until the OCR is complete.

Request

This endpoint expects an object.

mimeTypestringRequired

MIME type of the image. Supported types are image/png, image/jpeg, and application/pdf.

imagestringRequired

Base64 encoded image or PDF. PNG, JPG, WEBP, and PDF are supported. 10MB max.

vendorNetworkenumOptional

Limit OCR vendor search to a specific network

Allowed values:

entityIdstringOptional

When using the Entity vendor network, specify the entity to use. EntityId on an auth token will take precedence over this parameter.

splitDocumentbooleanOptional

If true, attempt to split the document into subdocuments before processing. Default is false. If a document is split into subdocuments, the linked OCR jobs will be accessible via the linkedJobIds field on each OCR job response.

Response

This endpoint returns an object.

jobIdstring

invoiceobject

vendorobject

checkobject or null

bankAccountobject or null

payerobject or null

Run OCR (Sync)

Headers

Request

Response

Errors