API ReferenceOCR

Get OCR Response (Async)

GET

Get the status and results of an asynchronous OCR job.

Path parameters

jobIdstringRequired

Response

This endpoint returns an object

jobId

string

status

enum

Allowed values: pendingsuccessfailed

data

objectOptional

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           "createdAt": "2021-01-01T00:00:00Z",
149           "updatedAt": "2021-01-01T00:00:00Z",
150           "amount": 100,
151           "description": "Product A",
152           "name": "Product A",
153           "quantity": 1,
154           "unitPrice": 100,
155           "serviceStartDate": "2021-01-01T00:00:00Z",
156           "serviceEndDate": "2021-01-31T00:00:00Z",
157           "metadata": {
158             "key1": "value1",
159             "key2": "value2"
160           },
161           "glAccountId": "600394"
162         }
163       ]
164     },
165     "vendor": {
166       "acceptedTos": false,
167       "accountType": "business",
168       "createdAt": "2024-01-01T00:00:00Z",
169       "email": "vendor@bigboxstore.com",
170       "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
171       "isCustomer": false,
172       "isNetworkPayee": false,
173       "isNetworkPayor": false,
174       "isPayee": true,
175       "isPayor": false,
176       "name": "Big Box Store",
177       "profile": {
178         "business": {
179           "legalBusinessName": "Big Box Store",
180           "taxIDProvided": false,
181           "email": "vendor@bigboxstore.com",
182           "businessType": "publicCorporation",
183           "ownersProvided": false
184         }
185       },
186       "status": "unverified",
187       "updatedAt": "2024-01-02T00:00:00Z",
188       "counterpartyType": [
189         "ENTITY"
190       ],
191       "foreignId": "MY-DB-ID-90909",
192       "paymentMethods": [
193         {
194           "type": "bankAccount",
195           "accountName": "Vendor Checking Account",
196           "accountNumber": "55934059697648",
197           "accountType": "CHECKING",
198           "bankName": "Chase",
199           "createdAt": "2021-01-01T00:00:00Z",
200           "frozen": false,
201           "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
202           "isDefaultDestination": true,
203           "isDefaultSource": true,
204           "metadata": {},
205           "routingNumber": "66554433",
206           "status": "NEW",
207           "supportedCurrencies": [
208             "USD"
209           ],
210           "updatedAt": "2021-01-01T00:00:00Z"
211         }
212       ]
213     },
214     "check": {
215       "addressLine1": "123 Main St",
216       "city": "New York",
217       "country": "US",
218       "createdAt": "2021-01-01T00:00:00Z",
219       "frozen": false,
220       "id": "pm_5fde2f4a-facc-48ef-8f0d-6b7d087c7b18",
221       "isDefaultDestination": true,
222       "isDefaultSource": false,
223       "metadata": {},
224       "payToTheOrderOf": "John Doe",
225       "postalCode": "10001",
226       "stateOrProvince": "NY",
227       "supportedCurrencies": [
228         "USD"
229       ],
230       "updatedAt": "2021-01-01T00:00:00Z",
231       "addressLine2": "Apt 1"
232     },
233     "bankAccount": {
234       "accountName": "Vendor Checking Account",
235       "accountNumber": "55934059697648",
236       "accountType": "CHECKING",
237       "bankName": "Chase",
238       "createdAt": "2021-01-01T00:00:00Z",
239       "frozen": false,
240       "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
241       "isDefaultDestination": true,
242       "isDefaultSource": true,
243       "metadata": {},
244       "routingNumber": "66554433",
245       "status": "NEW",
246       "supportedCurrencies": [
247         "USD"
248       ],
249       "updatedAt": "2021-01-01T00:00:00Z"
250     }
251   }
252 }

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	"createdAt": "2021-01-01T00:00:00Z",
149	"updatedAt": "2021-01-01T00:00:00Z",
150	"amount": 100,
151	"description": "Product A",
152	"name": "Product A",
153	"quantity": 1,
154	"unitPrice": 100,
155	"serviceStartDate": "2021-01-01T00:00:00Z",
156	"serviceEndDate": "2021-01-31T00:00:00Z",
157	"metadata": {
158	"key1": "value1",
159	"key2": "value2"
160	},
161	"glAccountId": "600394"
162	}
163	]
164	},
165	"vendor": {
166	"acceptedTos": false,
167	"accountType": "business",
168	"createdAt": "2024-01-01T00:00:00Z",
169	"email": "vendor@bigboxstore.com",
170	"id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
171	"isCustomer": false,
172	"isNetworkPayee": false,
173	"isNetworkPayor": false,
174	"isPayee": true,
175	"isPayor": false,
176	"name": "Big Box Store",
177	"profile": {
178	"business": {
179	"legalBusinessName": "Big Box Store",
180	"taxIDProvided": false,
181	"email": "vendor@bigboxstore.com",
182	"businessType": "publicCorporation",
183	"ownersProvided": false
184	}
185	},
186	"status": "unverified",
187	"updatedAt": "2024-01-02T00:00:00Z",
188	"counterpartyType": [
189	"ENTITY"
190	],
191	"foreignId": "MY-DB-ID-90909",
192	"paymentMethods": [
193	{
194	"type": "bankAccount",
195	"accountName": "Vendor Checking Account",
196	"accountNumber": "55934059697648",
197	"accountType": "CHECKING",
198	"bankName": "Chase",
199	"createdAt": "2021-01-01T00:00:00Z",
200	"frozen": false,
201	"id": "pm_7610541f-4619-4033-8620-cfccfb811293",
202	"isDefaultDestination": true,
203	"isDefaultSource": true,
204	"metadata": {},
205	"routingNumber": "66554433",
206	"status": "NEW",
207	"supportedCurrencies": [
208	"USD"
209	],
210	"updatedAt": "2021-01-01T00:00:00Z"
211	}
212	]
213	},
214	"check": {
215	"addressLine1": "123 Main St",
216	"city": "New York",
217	"country": "US",
218	"createdAt": "2021-01-01T00:00:00Z",
219	"frozen": false,
220	"id": "pm_5fde2f4a-facc-48ef-8f0d-6b7d087c7b18",
221	"isDefaultDestination": true,
222	"isDefaultSource": false,
223	"metadata": {},
224	"payToTheOrderOf": "John Doe",
225	"postalCode": "10001",
226	"stateOrProvince": "NY",
227	"supportedCurrencies": [
228	"USD"
229	],
230	"updatedAt": "2021-01-01T00:00:00Z",
231	"addressLine2": "Apt 1"
232	},
233	"bankAccount": {
234	"accountName": "Vendor Checking Account",
235	"accountNumber": "55934059697648",
236	"accountType": "CHECKING",
237	"bankName": "Chase",
238	"createdAt": "2021-01-01T00:00:00Z",
239	"frozen": false,
240	"id": "pm_7610541f-4619-4033-8620-cfccfb811293",
241	"isDefaultDestination": true,
242	"isDefaultSource": true,
243	"metadata": {},
244	"routingNumber": "66554433",
245	"status": "NEW",
246	"supportedCurrencies": [
247	"USD"
248	],
249	"updatedAt": "2021-01-01T00:00:00Z"
250	}
251	}
252	}