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           }
57         },
58         "status": "verified",
59         "updatedAt": "2024-01-02T00:00:00Z",
60         "accounts": [
61           {
62             "accountId": "85866843",
63             "postalCode": "94105",
64             "nameOnAccount": "John Doe"
65           }
66         ],
67         "counterpartyType": [
68           "ENTITY"
69         ],
70         "foreignId": "MY-DB-ID-12345",
71         "paymentMethods": [
72           {
73             "type": "bankAccount",
74             "accountName": "My Checking Account",
75             "accountNumber": "99988767623",
76             "accountType": "CHECKING",
77             "bankName": "Chase",
78             "createdAt": "2021-01-01T00:00:00Z",
79             "frozen": false,
80             "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
81             "isDefaultDestination": true,
82             "isDefaultSource": true,
83             "metadata": {},
84             "routingNumber": "12345678",
85             "status": "VERIFIED",
86             "supportedCurrencies": [
87               "USD"
88             ],
89             "updatedAt": "2021-01-01T00:00:00Z"
90           }
91         ]
92       },
93       "vendorId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
94       "vendor": {
95         "acceptedTos": false,
96         "accountType": "business",
97         "createdAt": "2024-01-01T00:00:00Z",
98         "email": "vendor@bigboxstore.com",
99         "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
100         "isCustomer": false,
101         "isNetworkPayee": false,
102         "isNetworkPayor": false,
103         "isPayee": true,
104         "isPayor": false,
105         "name": "Big Box Store",
106         "profile": {
107           "business": {
108             "legalBusinessName": "Big Box Store",
109             "taxIDProvided": false,
110             "email": "vendor@bigboxstore.com",
111             "businessType": "publicCorporation",
112             "ownersProvided": false
113           }
114         },
115         "status": "unverified",
116         "updatedAt": "2024-01-02T00:00:00Z",
117         "counterpartyType": [
118           "ENTITY"
119         ],
120         "foreignId": "MY-DB-ID-90909",
121         "paymentMethods": [
122           {
123             "type": "bankAccount",
124             "accountName": "Vendor Checking Account",
125             "accountNumber": "55934059697648",
126             "accountType": "CHECKING",
127             "bankName": "Chase",
128             "createdAt": "2021-01-01T00:00:00Z",
129             "frozen": false,
130             "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
131             "isDefaultDestination": true,
132             "isDefaultSource": true,
133             "metadata": {},
134             "routingNumber": "66554433",
135             "status": "NEW",
136             "supportedCurrencies": [
137               "USD"
138             ],
139             "updatedAt": "2021-01-01T00:00:00Z"
140           }
141         ]
142       },
143       "comments": [],
144       "lineItems": [
145         {
146           "id": "inli_26672f38-eb9a-48f1-a7a0-f1b855e38cd7",
147           "currency": "USD",
148           "category": "EXPENSE",
149           "createdAt": "2021-01-01T00:00:00Z",
150           "updatedAt": "2021-01-01T00:00:00Z",
151           "amount": 100,
152           "description": "Product A",
153           "name": "Product A",
154           "quantity": 1,
155           "unitPrice": 100,
156           "serviceStartDate": "2021-01-01T00:00:00Z",
157           "serviceEndDate": "2021-01-31T00:00:00Z",
158           "metadata": {
159             "key1": "value1",
160             "key2": "value2"
161           },
162           "glAccountId": "600394"
163         }
164       ]
165     },
166     "vendor": {
167       "acceptedTos": false,
168       "accountType": "business",
169       "createdAt": "2024-01-01T00:00:00Z",
170       "email": "vendor@bigboxstore.com",
171       "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
172       "isCustomer": false,
173       "isNetworkPayee": false,
174       "isNetworkPayor": false,
175       "isPayee": true,
176       "isPayor": false,
177       "name": "Big Box Store",
178       "profile": {
179         "business": {
180           "legalBusinessName": "Big Box Store",
181           "taxIDProvided": false,
182           "email": "vendor@bigboxstore.com",
183           "businessType": "publicCorporation",
184           "ownersProvided": false
185         }
186       },
187       "status": "unverified",
188       "updatedAt": "2024-01-02T00:00:00Z",
189       "counterpartyType": [
190         "ENTITY"
191       ],
192       "foreignId": "MY-DB-ID-90909",
193       "paymentMethods": [
194         {
195           "type": "bankAccount",
196           "accountName": "Vendor Checking Account",
197           "accountNumber": "55934059697648",
198           "accountType": "CHECKING",
199           "bankName": "Chase",
200           "createdAt": "2021-01-01T00:00:00Z",
201           "frozen": false,
202           "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
203           "isDefaultDestination": true,
204           "isDefaultSource": true,
205           "metadata": {},
206           "routingNumber": "66554433",
207           "status": "NEW",
208           "supportedCurrencies": [
209             "USD"
210           ],
211           "updatedAt": "2021-01-01T00:00:00Z"
212         }
213       ]
214     },
215     "check": {
216       "addressLine1": "123 Main St",
217       "city": "New York",
218       "country": "US",
219       "createdAt": "2021-01-01T00:00:00Z",
220       "frozen": false,
221       "id": "pm_5fde2f4a-facc-48ef-8f0d-6b7d087c7b18",
222       "isDefaultDestination": true,
223       "isDefaultSource": false,
224       "metadata": {},
225       "payToTheOrderOf": "John Doe",
226       "postalCode": "10001",
227       "stateOrProvince": "NY",
228       "supportedCurrencies": [
229         "USD"
230       ],
231       "updatedAt": "2021-01-01T00:00:00Z",
232       "addressLine2": "Apt 1"
233     },
234     "bankAccount": {
235       "accountName": "Vendor Checking Account",
236       "accountNumber": "55934059697648",
237       "accountType": "CHECKING",
238       "bankName": "Chase",
239       "createdAt": "2021-01-01T00:00:00Z",
240       "frozen": false,
241       "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
242       "isDefaultDestination": true,
243       "isDefaultSource": true,
244       "metadata": {},
245       "routingNumber": "66554433",
246       "status": "NEW",
247       "supportedCurrencies": [
248         "USD"
249       ],
250       "updatedAt": "2021-01-01T00:00:00Z"
251     }
252   }
253 }

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	}
57	},
58	"status": "verified",
59	"updatedAt": "2024-01-02T00:00:00Z",
60	"accounts": [
61	{
62	"accountId": "85866843",
63	"postalCode": "94105",
64	"nameOnAccount": "John Doe"
65	}
66	],
67	"counterpartyType": [
68	"ENTITY"
69	],
70	"foreignId": "MY-DB-ID-12345",
71	"paymentMethods": [
72	{
73	"type": "bankAccount",
74	"accountName": "My Checking Account",
75	"accountNumber": "99988767623",
76	"accountType": "CHECKING",
77	"bankName": "Chase",
78	"createdAt": "2021-01-01T00:00:00Z",
79	"frozen": false,
80	"id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
81	"isDefaultDestination": true,
82	"isDefaultSource": true,
83	"metadata": {},
84	"routingNumber": "12345678",
85	"status": "VERIFIED",
86	"supportedCurrencies": [
87	"USD"
88	],
89	"updatedAt": "2021-01-01T00:00:00Z"
90	}
91	]
92	},
93	"vendorId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
94	"vendor": {
95	"acceptedTos": false,
96	"accountType": "business",
97	"createdAt": "2024-01-01T00:00:00Z",
98	"email": "vendor@bigboxstore.com",
99	"id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
100	"isCustomer": false,
101	"isNetworkPayee": false,
102	"isNetworkPayor": false,
103	"isPayee": true,
104	"isPayor": false,
105	"name": "Big Box Store",
106	"profile": {
107	"business": {
108	"legalBusinessName": "Big Box Store",
109	"taxIDProvided": false,
110	"email": "vendor@bigboxstore.com",
111	"businessType": "publicCorporation",
112	"ownersProvided": false
113	}
114	},
115	"status": "unverified",
116	"updatedAt": "2024-01-02T00:00:00Z",
117	"counterpartyType": [
118	"ENTITY"
119	],
120	"foreignId": "MY-DB-ID-90909",
121	"paymentMethods": [
122	{
123	"type": "bankAccount",
124	"accountName": "Vendor Checking Account",
125	"accountNumber": "55934059697648",
126	"accountType": "CHECKING",
127	"bankName": "Chase",
128	"createdAt": "2021-01-01T00:00:00Z",
129	"frozen": false,
130	"id": "pm_7610541f-4619-4033-8620-cfccfb811293",
131	"isDefaultDestination": true,
132	"isDefaultSource": true,
133	"metadata": {},
134	"routingNumber": "66554433",
135	"status": "NEW",
136	"supportedCurrencies": [
137	"USD"
138	],
139	"updatedAt": "2021-01-01T00:00:00Z"
140	}
141	]
142	},
143	"comments": [],
144	"lineItems": [
145	{
146	"id": "inli_26672f38-eb9a-48f1-a7a0-f1b855e38cd7",
147	"currency": "USD",
148	"category": "EXPENSE",
149	"createdAt": "2021-01-01T00:00:00Z",
150	"updatedAt": "2021-01-01T00:00:00Z",
151	"amount": 100,
152	"description": "Product A",
153	"name": "Product A",
154	"quantity": 1,
155	"unitPrice": 100,
156	"serviceStartDate": "2021-01-01T00:00:00Z",
157	"serviceEndDate": "2021-01-31T00:00:00Z",
158	"metadata": {
159	"key1": "value1",
160	"key2": "value2"
161	},
162	"glAccountId": "600394"
163	}
164	]
165	},
166	"vendor": {
167	"acceptedTos": false,
168	"accountType": "business",
169	"createdAt": "2024-01-01T00:00:00Z",
170	"email": "vendor@bigboxstore.com",
171	"id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
172	"isCustomer": false,
173	"isNetworkPayee": false,
174	"isNetworkPayor": false,
175	"isPayee": true,
176	"isPayor": false,
177	"name": "Big Box Store",
178	"profile": {
179	"business": {
180	"legalBusinessName": "Big Box Store",
181	"taxIDProvided": false,
182	"email": "vendor@bigboxstore.com",
183	"businessType": "publicCorporation",
184	"ownersProvided": false
185	}
186	},
187	"status": "unverified",
188	"updatedAt": "2024-01-02T00:00:00Z",
189	"counterpartyType": [
190	"ENTITY"
191	],
192	"foreignId": "MY-DB-ID-90909",
193	"paymentMethods": [
194	{
195	"type": "bankAccount",
196	"accountName": "Vendor Checking Account",
197	"accountNumber": "55934059697648",
198	"accountType": "CHECKING",
199	"bankName": "Chase",
200	"createdAt": "2021-01-01T00:00:00Z",
201	"frozen": false,
202	"id": "pm_7610541f-4619-4033-8620-cfccfb811293",
203	"isDefaultDestination": true,
204	"isDefaultSource": true,
205	"metadata": {},
206	"routingNumber": "66554433",
207	"status": "NEW",
208	"supportedCurrencies": [
209	"USD"
210	],
211	"updatedAt": "2021-01-01T00:00:00Z"
212	}
213	]
214	},
215	"check": {
216	"addressLine1": "123 Main St",
217	"city": "New York",
218	"country": "US",
219	"createdAt": "2021-01-01T00:00:00Z",
220	"frozen": false,
221	"id": "pm_5fde2f4a-facc-48ef-8f0d-6b7d087c7b18",
222	"isDefaultDestination": true,
223	"isDefaultSource": false,
224	"metadata": {},
225	"payToTheOrderOf": "John Doe",
226	"postalCode": "10001",
227	"stateOrProvince": "NY",
228	"supportedCurrencies": [
229	"USD"
230	],
231	"updatedAt": "2021-01-01T00:00:00Z",
232	"addressLine2": "Apt 1"
233	},
234	"bankAccount": {
235	"accountName": "Vendor Checking Account",
236	"accountNumber": "55934059697648",
237	"accountType": "CHECKING",
238	"bankName": "Chase",
239	"createdAt": "2021-01-01T00:00:00Z",
240	"frozen": false,
241	"id": "pm_7610541f-4619-4033-8620-cfccfb811293",
242	"isDefaultDestination": true,
243	"isDefaultSource": true,
244	"metadata": {},
245	"routingNumber": "66554433",
246	"status": "NEW",
247	"supportedCurrencies": [
248	"USD"
249	],
250	"updatedAt": "2021-01-01T00:00:00Z"
251	}
252	}
253	}