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>"

200Default

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