Get OCR Response (Async)

GET

https://api.mercoa.com/ocr-async/:jobId

GET

/ocr-async/:jobId

1 from mercoa import Mercoa
2 
3 client = Mercoa(
4     token="YOUR_TOKEN",
5 )
6 client.ocr.get_async_ocr(
7     job_id="ocr_8f86116b-3b4d-4ded-99ef-3bc929d8c33c",
8 )

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

Get the status and results of an asynchronous OCR job.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

jobIdstringRequired

Response

This endpoint returns an object.

jobIdstring

statusenum

The status of the OCR job.

Allowed values:

linkedJobIdslist of strings

The IDs of any OCR jobs that are processing other subdocuments of the same document.

pageRangeobject

The start and end page numbers of the corresponding subdocument (zero-indexed, inclusive). If not provided, the document was not split during OCR.

dataobject

Errors

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

500

Internal Server Error

501

Unimplemented