Run OCR (Sync) — Mercoa

Run OCR on an Base64 encoded image or PDF. This endpoint will block until the OCR is complete.

Request

This endpoint expects an object.

mimeTypestringRequired

MIME type of the image. Supported types are image/png, image/jpeg, and application/pdf.

imagestringRequired

Base64 encoded image or PDF. PNG, JPG, WEBP, and PDF are supported. 10MB max.

vendorNetworkenumOptional

Allowed values: allplatformentity

Limit OCR vendor search to a specific network

entityIdstringOptional

When using the Entity vendor network, specify the entity to use if. EntityId on an auth token will take precedence over this parameter.

Response

This endpoint returns an object.

invoiceobject

vendorobject

checkobjectOptional

bankAccountobjectOptional

1 curl -X POST https://api.mercoa.com/ocr \ 2 -H "Authorization: Bearer <token>" \ 3 -H "Content-Type: application/json" \ 4 -d '{ 5 "mimeType": "image/png", 6 "image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAgAAAAIAQMAAAD+wSzIAAAABlBMVEX///+/v7+jQ3Y5AAAADklEQVQI12P4AIX8EAgALgAD/aNpbtEAAAAASUVORK5CYII", 7 "vendorNetwork": "entity", 8 "entityId": "entity_8f86116b-3b4d-4ded-99ef-3bc929d8c33c" 9 }'

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

1	curl -X POST https://api.mercoa.com/ocr \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"mimeType": "image/png",
6	"image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAgAAAAIAQMAAAD+wSzIAAAABlBMVEX///+/v7+jQ3Y5AAAADklEQVQI12P4AIX8EAgALgAD/aNpbtEAAAAASUVORK5CYII",
7	"vendorNetwork": "entity",
8	"entityId": "entity_8f86116b-3b4d-4ded-99ef-3bc929d8c33c"
9	}'

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