OCR Job Completed

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

The payload of this webhook request is an object.
eventTypestringRequired
The type of the event.
jobIdstringRequired
The ID of the OCR job that completed.
statusenumRequired
The final status of the OCR job.
Allowed values:
dataobjectOptional
The OCR job results. Only present if the job was successful.
linkedJobIdslist of stringsOptional
The IDs of any linked OCR jobs that are processing other subdocuments of the same document.
pageRangeobjectOptional
The start and end page numbers of the corresponding subdocument (zero-indexed, inclusive). If not provided, the document was not split during OCR.
Response

200
any
Return a 200 status to indicate that the data was received successfully.