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.

mimeType

stringRequired

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

image

stringRequired

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

vendorNetwork

enumOptional

Limit OCR vendor search to a specific network

Allowed values: allplatformentity

entityId

stringOptional

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

invoice

object

vendor

object

check

objectOptional

bankAccount

objectOptional

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

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