Get OCR Response (Async)

GET

Get the status and results of an asynchronous OCR job.

Path parameters

jobIdstringRequired

Response

This endpoint returns an object.

jobIdstring

statusenum

Allowed values: pendingsuccessfailed

dataobjectOptional

GET

1 curl https://api.mercoa.com/ocr-async/ocr_8f86116b-3b4d-4ded-99ef-3bc929d8c33c \
2      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "jobId": "ocr_8f86116b-3b4d-4ded-99ef-3bc929d8c33c",
3   "status": "success",
4   "data": {
5     "invoice": {
6       "id": "inv_26e7b5d3-a739-4b23-9ad9-6aaa085f47a9",
7       "status": "DRAFT",
8       "paymentDestinationConfirmed": false,
9       "hasDocuments": true,
10       "hasSourceEmail": true,
11       "approvers": [],
12       "approvalPolicy": [],
13       "metadata": {},
14       "createdAt": "2021-01-01T00:00:00Z",
15       "updatedAt": "2021-01-01T00:00:00Z",
16       "amount": 100,
17       "currency": "USD",
18       "invoiceDate": "2021-01-01T00:00:00Z",
19       "dueDate": "2021-01-31T00:00:00Z",
20       "invoiceNumber": "INV-123",
21       "noteToSelf": "For the month of January",
22       "serviceStartDate": "2021-01-01T00:00:00Z",
23       "serviceEndDate": "2021-01-31T00:00:00Z",
24       "payerId": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
25       "payer": {
26         "acceptedTos": true,
27         "accountType": "business",
28         "createdAt": "2024-01-01T00:00:00Z",
29         "email": "customer@acme.com",
30         "id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
31         "isCustomer": true,
32         "isNetworkPayee": false,
33         "isNetworkPayor": false,
34         "isPayee": false,
35         "isPayor": true,
36         "name": "Acme Inc.",
37         "profile": {
38           "business": {
39             "legalBusinessName": "Acme Inc.",
40             "taxIDProvided": true,
41             "email": "customer@acme.com",
42             "businessType": "llc",
43             "phone": {
44               "countryCode": "1",
45               "number": "4155551234"
46             },
47             "address": {
48               "addressLine1": "123 Main St",
49               "city": "San Francisco",
50               "stateOrProvince": "CA",
51               "postalCode": "94105",
52               "addressLine2": "Unit 1",
53               "country": "US"
54             },
55             "ownersProvided": true,
56             "taxId": {
57               "ein": {
58                 "number": "12-3456789"
59               }
60             }
61           }
62         },
63         "status": "verified",
64         "updatedAt": "2024-01-02T00:00:00Z",
65         "accounts": [
66           {
67             "accountId": "85866843",
68             "postalCode": "94105",
69             "nameOnAccount": "John Doe"
70           }
71         ],
72         "counterpartyType": [
73           "ENTITY"
74         ],
75         "foreignId": "MY-DB-ID-12345",
76         "paymentMethods": [
77           {
78             "type": "bankAccount",
79             "accountName": "My Checking Account",
80             "accountNumber": "99988767623",
81             "accountType": "CHECKING",
82             "bankName": "Chase",
83             "createdAt": "2021-01-01T00:00:00Z",
84             "frozen": false,
85             "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
86             "isDefaultDestination": true,
87             "isDefaultSource": true,
88             "metadata": {},
89             "routingNumber": "12345678",
90             "status": "VERIFIED",
91             "supportedCurrencies": [
92               "USD"
93             ],
94             "updatedAt": "2021-01-01T00:00:00Z"
95           }
96         ]
97       },
98       "vendorId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
99       "vendor": {
100         "acceptedTos": false,
101         "accountType": "business",
102         "createdAt": "2024-01-01T00:00:00Z",
103         "email": "vendor@bigboxstore.com",
104         "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
105         "isCustomer": false,
106         "isNetworkPayee": false,
107         "isNetworkPayor": false,
108         "isPayee": true,
109         "isPayor": false,
110         "name": "Big Box Store",
111         "profile": {
112           "business": {
113             "legalBusinessName": "Big Box Store",
114             "taxIDProvided": false,
115             "email": "vendor@bigboxstore.com",
116             "businessType": "publicCorporation",
117             "ownersProvided": false
118           }
119         },
120         "status": "unverified",
121         "updatedAt": "2024-01-02T00:00:00Z",
122         "counterpartyType": [
123           "ENTITY"
124         ],
125         "foreignId": "MY-DB-ID-90909",
126         "paymentMethods": [
127           {
128             "type": "bankAccount",
129             "accountName": "Vendor Checking Account",
130             "accountNumber": "55934059697648",
131             "accountType": "CHECKING",
132             "bankName": "Chase",
133             "createdAt": "2021-01-01T00:00:00Z",
134             "frozen": false,
135             "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
136             "isDefaultDestination": true,
137             "isDefaultSource": true,
138             "metadata": {},
139             "routingNumber": "66554433",
140             "status": "NEW",
141             "supportedCurrencies": [
142               "USD"
143             ],
144             "updatedAt": "2021-01-01T00:00:00Z"
145           }
146         ]
147       },
148       "comments": [],
149       "lineItems": [
150         {
151           "id": "inli_26672f38-eb9a-48f1-a7a0-f1b855e38cd7",
152           "currency": "USD",
153           "category": "EXPENSE",
154           "createdAt": "2021-01-01T00:00:00Z",
155           "updatedAt": "2021-01-01T00:00:00Z",
156           "amount": 100,
157           "description": "Product A",
158           "name": "Product A",
159           "quantity": 1,
160           "unitPrice": 100,
161           "serviceStartDate": "2021-01-01T00:00:00Z",
162           "serviceEndDate": "2021-01-31T00:00:00Z",
163           "metadata": {
164             "key1": "value1",
165             "key2": "value2"
166           },
167           "glAccountId": "600394"
168         }
169       ]
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         }
218       ]
219     },
220     "check": {
221       "addressLine1": "123 Main St",
222       "city": "New York",
223       "country": "US",
224       "createdAt": "2021-01-01T00:00:00Z",
225       "frozen": false,
226       "id": "pm_5fde2f4a-facc-48ef-8f0d-6b7d087c7b18",
227       "isDefaultDestination": true,
228       "isDefaultSource": false,
229       "metadata": {},
230       "payToTheOrderOf": "John Doe",
231       "postalCode": "10001",
232       "stateOrProvince": "NY",
233       "supportedCurrencies": [
234         "USD"
235       ],
236       "updatedAt": "2021-01-01T00:00:00Z",
237       "addressLine2": "Apt 1"
238     },
239     "bankAccount": {
240       "accountName": "Vendor Checking Account",
241       "accountNumber": "55934059697648",
242       "accountType": "CHECKING",
243       "bankName": "Chase",
244       "createdAt": "2021-01-01T00:00:00Z",
245       "frozen": false,
246       "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
247       "isDefaultDestination": true,
248       "isDefaultSource": true,
249       "metadata": {},
250       "routingNumber": "66554433",
251       "status": "NEW",
252       "supportedCurrencies": [
253         "USD"
254       ],
255       "updatedAt": "2021-01-01T00:00:00Z"
256     }
257   }
258 }

Find

Up Next

Built with

1	curl https://api.mercoa.com/ocr-async/ocr_8f86116b-3b4d-4ded-99ef-3bc929d8c33c \
2	-H "Authorization: Bearer <token>"

1	{
2	"jobId": "ocr_8f86116b-3b4d-4ded-99ef-3bc929d8c33c",
3	"status": "success",
4	"data": {
5	"invoice": {
6	"id": "inv_26e7b5d3-a739-4b23-9ad9-6aaa085f47a9",
7	"status": "DRAFT",
8	"paymentDestinationConfirmed": false,
9	"hasDocuments": true,
10	"hasSourceEmail": true,
11	"approvers": [],
12	"approvalPolicy": [],
13	"metadata": {},
14	"createdAt": "2021-01-01T00:00:00Z",
15	"updatedAt": "2021-01-01T00:00:00Z",
16	"amount": 100,
17	"currency": "USD",
18	"invoiceDate": "2021-01-01T00:00:00Z",
19	"dueDate": "2021-01-31T00:00:00Z",
20	"invoiceNumber": "INV-123",
21	"noteToSelf": "For the month of January",
22	"serviceStartDate": "2021-01-01T00:00:00Z",
23	"serviceEndDate": "2021-01-31T00:00:00Z",
24	"payerId": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
25	"payer": {
26	"acceptedTos": true,
27	"accountType": "business",
28	"createdAt": "2024-01-01T00:00:00Z",
29	"email": "customer@acme.com",
30	"id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
31	"isCustomer": true,
32	"isNetworkPayee": false,
33	"isNetworkPayor": false,
34	"isPayee": false,
35	"isPayor": true,
36	"name": "Acme Inc.",
37	"profile": {
38	"business": {
39	"legalBusinessName": "Acme Inc.",
40	"taxIDProvided": true,
41	"email": "customer@acme.com",
42	"businessType": "llc",
43	"phone": {
44	"countryCode": "1",
45	"number": "4155551234"
46	},
47	"address": {
48	"addressLine1": "123 Main St",
49	"city": "San Francisco",
50	"stateOrProvince": "CA",
51	"postalCode": "94105",
52	"addressLine2": "Unit 1",
53	"country": "US"
54	},
55	"ownersProvided": true,
56	"taxId": {
57	"ein": {
58	"number": "12-3456789"
59	}
60	}
61	}
62	},
63	"status": "verified",
64	"updatedAt": "2024-01-02T00:00:00Z",
65	"accounts": [
66	{
67	"accountId": "85866843",
68	"postalCode": "94105",
69	"nameOnAccount": "John Doe"
70	}
71	],
72	"counterpartyType": [
73	"ENTITY"
74	],
75	"foreignId": "MY-DB-ID-12345",
76	"paymentMethods": [
77	{
78	"type": "bankAccount",
79	"accountName": "My Checking Account",
80	"accountNumber": "99988767623",
81	"accountType": "CHECKING",
82	"bankName": "Chase",
83	"createdAt": "2021-01-01T00:00:00Z",
84	"frozen": false,
85	"id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
86	"isDefaultDestination": true,
87	"isDefaultSource": true,
88	"metadata": {},
89	"routingNumber": "12345678",
90	"status": "VERIFIED",
91	"supportedCurrencies": [
92	"USD"
93	],
94	"updatedAt": "2021-01-01T00:00:00Z"
95	}
96	]
97	},
98	"vendorId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
99	"vendor": {
100	"acceptedTos": false,
101	"accountType": "business",
102	"createdAt": "2024-01-01T00:00:00Z",
103	"email": "vendor@bigboxstore.com",
104	"id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
105	"isCustomer": false,
106	"isNetworkPayee": false,
107	"isNetworkPayor": false,
108	"isPayee": true,
109	"isPayor": false,
110	"name": "Big Box Store",
111	"profile": {
112	"business": {
113	"legalBusinessName": "Big Box Store",
114	"taxIDProvided": false,
115	"email": "vendor@bigboxstore.com",
116	"businessType": "publicCorporation",
117	"ownersProvided": false
118	}
119	},
120	"status": "unverified",
121	"updatedAt": "2024-01-02T00:00:00Z",
122	"counterpartyType": [
123	"ENTITY"
124	],
125	"foreignId": "MY-DB-ID-90909",
126	"paymentMethods": [
127	{
128	"type": "bankAccount",
129	"accountName": "Vendor Checking Account",
130	"accountNumber": "55934059697648",
131	"accountType": "CHECKING",
132	"bankName": "Chase",
133	"createdAt": "2021-01-01T00:00:00Z",
134	"frozen": false,
135	"id": "pm_7610541f-4619-4033-8620-cfccfb811293",
136	"isDefaultDestination": true,
137	"isDefaultSource": true,
138	"metadata": {},
139	"routingNumber": "66554433",
140	"status": "NEW",
141	"supportedCurrencies": [
142	"USD"
143	],
144	"updatedAt": "2021-01-01T00:00:00Z"
145	}
146	]
147	},
148	"comments": [],
149	"lineItems": [
150	{
151	"id": "inli_26672f38-eb9a-48f1-a7a0-f1b855e38cd7",
152	"currency": "USD",
153	"category": "EXPENSE",
154	"createdAt": "2021-01-01T00:00:00Z",
155	"updatedAt": "2021-01-01T00:00:00Z",
156	"amount": 100,
157	"description": "Product A",
158	"name": "Product A",
159	"quantity": 1,
160	"unitPrice": 100,
161	"serviceStartDate": "2021-01-01T00:00:00Z",
162	"serviceEndDate": "2021-01-31T00:00:00Z",
163	"metadata": {
164	"key1": "value1",
165	"key2": "value2"
166	},
167	"glAccountId": "600394"
168	}
169	]
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	}
218	]
219	},
220	"check": {
221	"addressLine1": "123 Main St",
222	"city": "New York",
223	"country": "US",
224	"createdAt": "2021-01-01T00:00:00Z",
225	"frozen": false,
226	"id": "pm_5fde2f4a-facc-48ef-8f0d-6b7d087c7b18",
227	"isDefaultDestination": true,
228	"isDefaultSource": false,
229	"metadata": {},
230	"payToTheOrderOf": "John Doe",
231	"postalCode": "10001",
232	"stateOrProvince": "NY",
233	"supportedCurrencies": [
234	"USD"
235	],
236	"updatedAt": "2021-01-01T00:00:00Z",
237	"addressLine2": "Apt 1"
238	},
239	"bankAccount": {
240	"accountName": "Vendor Checking Account",
241	"accountNumber": "55934059697648",
242	"accountType": "CHECKING",
243	"bankName": "Chase",
244	"createdAt": "2021-01-01T00:00:00Z",
245	"frozen": false,
246	"id": "pm_7610541f-4619-4033-8620-cfccfb811293",
247	"isDefaultDestination": true,
248	"isDefaultSource": true,
249	"metadata": {},
250	"routingNumber": "66554433",
251	"status": "NEW",
252	"supportedCurrencies": [
253	"USD"
254	],
255	"updatedAt": "2021-01-01T00:00:00Z"
256	}
257	}
258	}