-
Notifications
You must be signed in to change notification settings - Fork 6
/
lob-api-public.yml
2562 lines (2396 loc) · 129 KB
/
lob-api-public.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.3
info:
title: Lob
version: 1.19.43
description: |
The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors. <p>
license:
name: MIT
url: https://mit-license.org/
contact:
name: Lob Developer Experience
url: https://support.lob.com/
email: lob-openapi@lob.com
termsOfService: https://www.lob.com/legal
servers:
- url: https://api.lob.com/v1
description: production
tags:
- name: Addresses
description: |
To add an address to your address book, you create a new address object. You can retrieve and delete individual
addresses as well as get a list of addresses. Addresses are identified by a unique random ID.
<div class="back-to-top" ><a href="#" onclick="toTopLink()">back to top</a></div>
- name: Authentication
x-traitTag: true
description: |
Requests made to the API are protected with <a href="https://en.wikipedia.org/wiki/Basic_access_authentication" target="_blank">HTTP Basic authentication</a>.
In order to properly authenticate with the API you must use your API key as the username
while leaving the password blank. Requests not properly authenticated will return a `401`
[error code](#tag/Errors). You can find your account's API keys
in your <a href="https://dashboard.lob.com/settings/api-keys" target="_blank">Dashboard Settings</a>.
### Example Request
curl uses the -u flag to pass basic auth credentials (adding a colon after your API key will prevent it from asking you for a
password). One of our test API keys has been filled into all the examples on the page, so you can test out any example right away.
```bash
curl https://api.lob.com/v1/addresses \
-u test_0dc8dXXXXXXXXXXXXXXXXXXXXXX5b0cc:
```
## API Keys
Lob authenticates your API requests using your account's API keys.
If you do not include your key when making an API request, or use
one that is incorrect or outdated, Lob returns an error with a `401`
HTTP response code. You can find all API keys in your dashboard
under <a href="https://dashboard.lob.com/settings/api-keys" target="_blank">Settings</a>.
There are two types of API keys: *secret* and *publishable*.
- **Secret API keys** should be kept confidential and only stored on your own servers.
Your account's secret API key can perform any API request to Lob without restriction.
- **Publishable API keys** are limited to US verifications, international verifications,
and US autocomplete requests. For maximum security, we encourage you to not expose your
secret key. You can include the publishable keys in JavaScript code or in an Android or iPhone app
without exposing your Lob Print and Mail account services or your secret key. Publishable keys are always
prefixed with `[environment]_pub`.
Every type comes with a pair of keys: one for the testing environment and one for the
live environment. We recommend reading [Test and Live Environments](#tag/Test-and-Live-Environments)
for more information.
<br><br>
<div class="back-to-top" ><a href="#" onclick="toTopLink()">back to top</a></div>
- name: Bank Accounts
description: |
Bank Accounts allow you to store your bank account securely in our system. The API provides
endpoints for creating bank accounts, deleting bank accounts, verifying bank accounts,
retrieving individual bank accounts, and retrieving a list of bank accounts.
<div class="back-to-top" ><a href="#" onclick="toTopLink()">back to top</a></div>
- name: Beta Program
x-traitTag: true
description: |
At Lob, we pride ourselves on building high quality platform capabilities rapidly
and iteratively, so we can constantly be delivering additional value to our customers.
When evaluating a new product or feature from Lob, you may see that it has been released in Beta.
Typically, something in Beta means that the feature is early in its lifecycle here at
Lob. While we fully stand behind the quality of everything we release in Beta, we do
anticipate receiving a higher level of customer feedback on Beta features, as well as a
faster pace of changes from our engineering team in response to that feedback.
By participating in a Lob Beta program, you will have the opportunity to get early access
to a new product capability, as well as having a unique opportunity to influence the product's
direction with your feedback.
You should also anticipate that features in Beta may have functional or design limitations,
and might change rapidly as we receive customer feedback and make improvements. In particular,
new APIs in Beta may also go through more frequent versioning and version deprecation cycles
than our more mature APIs.
If you are participating in a Beta program and want to provide feedback, please feel free to
<a href="https://lob.com/support#contact" target="_blank">contact us</a>!
<div class="back-to-top" ><a href="#" onclick="toTopLink()">back to top</a></div>
- name: Billing Groups
description: |
The Billing Groups API allows you to create and view labels that can be attached to certain consumption-based
usages of Letters, Checks, Postcards and Self-Mailers to customize your bill. Please check each
resource API section to learn more about how to access the Billing Groups API.
<div class="back-to-top" ><a href="#" onclick="toTopLink()">back to top</a></div>
- name: Buckslip Orders
description: |
The Buckslip Orders endpoint allows you to easily create buckslip orders for existing buckslips.
The API provides endpoints for creating buckslip orders and listing buckslip orders for a given buckslip.
<div class="back-to-top" ><a href="#" onclick="toTopLink()">back to top</a></div>
- name: Buckslips
description: |
The Buckslips endpoint allows you to easily create buckslips that can later be used as add-ons for Letters Campaigns. Note that a Letter Campaign with Buckslip add-on requires a minimum send quantity of 5,000 letters.
The API provides endpoints for creating buckslips, retrieving individual buckslips, creating buckslip orders, and retrieving a list of buckslips.
<div class="back-to-top" ><a href="#" onclick="toTopLink()">back to top</a></div>
- name: Bulk Intl Verifications
description: |
Verify a list of non-US addresses.
<div class="back-to-top" ><a href="#" onclick="toTopLink()">back to top</a></div>
- name: Bulk US Verifications
description: |
Verify a list of US addresses.
<div class="back-to-top" ><a href="#" onclick="toTopLink()">back to top</a></div>
- name: Campaigns
description: |
The campaigns endpoint allows you to create and view campaigns that can be used to send multiple letters or postcards.
The API provides endpoints for creating campaigns, updating campaigns, retrieving individual campaigns, listing campaigns, and deleting
campaigns.
- name: Card Orders
description: |
The card orders endpoint allows you to easily create card orders for existing cards.
The API provides endpoints for creating card orders and listing card orders for a given card.
<div class="back-to-top" ><a href="#" onclick="toTopLink()">back to top</a></div>
- name: Cards
description: |
The cards endpoint allows you to easily create cards that can later be affixed to Letters.
The API provides endpoints for creating cards, retrieving individual cards, creating card orders, and retrieving a list of cards.
<div class="back-to-top" ><a href="#" onclick="toTopLink()">back to top</a></div>
- name: Checks
description: |
Checks allow you to send payments via physical checks. The API provides endpoints
for creating checks, retrieving individual checks, canceling checks, and retrieving a list of checks.
<div class="back-to-top" ><a href="#" onclick="toTopLink()">back to top</a></div>
- name: Creatives
description: |
The creatives endpoint allows you to create and view creatives. Creatives are used to create
reusable letter and postcard templates. The API provides endpoints for creating creatives, updating creatives,
retrieving individual creatives, and deleting creatives.
- name: Errors
x-traitTag: true
description: |
Lob uses RESTful HTTP response codes to indicate success or failure of an API request - read below for more information. In general, 2xx indicates success, 4xx indicate an input error, and 5xx indicates an error on Lob's end.
<table>
<tr>
<th style="white-space: nowrap">ATTRIBUTE</th>
<th style="white-space: nowrap">DESCRIPTION</th>
</tr>
<tr>
<td style="white-space: nowrap"><code>code</code></td>
<td style="white-space: nowrap">A consistent machine-keyable string identifying the error</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>status_code</code></td>
<td style="white-space: nowrap">A conventional HTTP status code</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>message</code></td>
<td style="white-space: nowrap">A human-readable, subject-to-change message with more details about the error</td>
</tr>
</table>
### HTTP Status Code Summary
<table>
<tr>
<th style="white-space: nowrap">STATUS_CODE</th>
<th style="white-space: nowrap">CODE</th>
<th style="white-space: nowrap">MESSAGE</th>
</tr>
<tr>
<td style="white-space: nowrap"><code>200</code></td>
<td style="white-space: nowrap">SUCCESS</td>
<td style="white-space: nowrap">Successful API request</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>401</code></td>
<td style="white-space: nowrap">UNAUTHORIZED</td>
<td style="white-space: nowrap">Authorization error with your API key or account</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>403</code></td>
<td style="white-space: nowrap">FORBIDDEN</td>
<td style="white-space: nowrap">Forbidden error with your API key or account</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>404</code></td>
<td style="white-space: nowrap">NOT FOUND</td>
<td style="white-space: nowrap">The requested item does not exist</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>422</code></td>
<td style="white-space: nowrap">BAD REQUEST</td>
<td style="white-space: nowrap">The query or body parameters did not pass validation</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>429</code></td>
<td style="white-space: nowrap">TOO MANY REQUESTS</td>
<td style="white-space: nowrap">Too many requests have been sent with an API key in a given amount of time</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>500</code></td>
<td style="white-space: nowrap">SERVER ERROR</td>
<td style="white-space: nowrap">An internal server error occurred, please contact support@lob.com</td>
</tr>
</table>
### Error Codes - Generic
<table>
<tr>
<th style="white-space: nowrap">STATUS_CODE</th>
<th style="white-space: nowrap">CODE</th>
<th style="white-space: nowrap">MESSAGE</th>
</tr>
<tr>
<td style="white-space: nowrap"><code>422</code></td>
<td style="white-space: nowrap">BAD_REQUEST</td>
<td style="white-space: nowrap">An invalid request was made. See error message for details.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>409/422</code></td>
<td style="white-space: nowrap">CONFLICT</td>
<td style="white-space: nowrap">This operation would leave data in a conflicted state.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>403</code></td>
<td style="white-space: nowrap">FEATURE_LIMIT_REACHED</td>
<td style="white-space: nowrap">The account has reached its resource limit and requires upgrading to add more.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>500</code></td>
<td style="white-space: nowrap">INTERNAL_SERVER_ERROR</td>
<td style="white-space: nowrap">An error has occured on Lob's servers. Please try request again.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>422</code></td>
<td style="white-space: nowrap">INVALID</td>
<td style="white-space: nowrap">An invalid request was made. See error message for details.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>422</code></td>
<td style="white-space: nowrap">NOT_DELETABLE</td>
<td style="white-space: nowrap">An attempt was made to delete a resource, but the resource cannot be deleted.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>404</code></td>
<td style="white-space: nowrap">NOT_FOUND</td>
<td style="white-space: nowrap">The requested resource was not found.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>408</code></td>
<td style="white-space: nowrap">REQUEST_TIMEOUT</td>
<td style="white-space: nowrap">The request took too long. Please try again.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>503</code></td>
<td style="white-space: nowrap">SERVICE_UNAVAILABLE</td>
<td style="white-space: nowrap">The Lob servers are temporarily unavailable. Please try again.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>404</code></td>
<td style="white-space: nowrap">UNRECOGNIZED_ENDPOINT</td>
<td style="white-space: nowrap">The requested endpoint doesn't exist.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>422</code></td>
<td style="white-space: nowrap">UNSUPPORTED_LOB_VERSION</td>
<td style="white-space: nowrap">An unsupported Lob API version was requested.</td>
</tr>
</table>
### Error Codes - Authentication
<table>
<tr>
<th style="white-space: nowrap">STATUS_CODE</th>
<th style="white-space: nowrap">CODE</th>
<th style="white-space: nowrap">MESSAGE</th>
</tr>
<tr>
<td style="white-space: nowrap"><code>401</code></td>
<td style="white-space: nowrap">EMAIL_REQUIRED</td>
<td style="white-space: nowrap">Account must have a verified email address before creating live resources.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>401</code></td>
<td style="white-space: nowrap">UNAUTHORIZED</td>
<td style="white-space: nowrap">The request isn't authorized.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>401</code></td>
<td style="white-space: nowrap">UNAUTHORIZED_TOKEN</td>
<td style="white-space: nowrap">Token isn't authorized.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>401/403</code></td>
<td style="white-space: nowrap">INVALID_API_KEY</td>
<td style="white-space: nowrap">The API key is invalid.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>403</code></td>
<td style="white-space: nowrap">PUBLISHABLE_KEY_NOT_ALLOWED</td>
<td style="white-space: nowrap">The requested operation needs a secret key, not a publishable key. See [API Keys](#tag/API-Keys) for more information.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>429</code></td>
<td style="white-space: nowrap">RATE_LIMIT_EXCEEDED</td>
<td style="white-space: nowrap">Requests were sent too quickly and must be slowed down.</td>
</tr>
</table>
### Error Codes - Advanced
<table>
<tr>
<th style="white-space: nowrap">STATUS_CODE</th>
<th style="white-space: nowrap">CODE</th>
<th style="white-space: nowrap">MESSAGE</th>
</tr>
<tr>
<td style="white-space: nowrap"><code>401</code></td>
<td style="white-space: nowrap">PAYMENT_METHOD_UNVERIFIED</td>
<td style="white-space: nowrap">You must have a verified bank account or credit card to submit live requests.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>404</code></td>
<td style="white-space: nowrap">DELETED_BANK_ACCOUNT</td>
<td style="white-space: nowrap">Checks cannot be created with a deleted bank account.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>422</code></td>
<td style="white-space: nowrap">ADDRESS_LENGTH_EXCEEDS_LIMIT</td>
<td style="white-space: nowrap">The sum of to.address_line1 and to.address_line2 cannot surpass 50 characters.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>422</code></td>
<td style="white-space: nowrap">BANK_ACCOUNT_ALREADY_VERIFIED</td>
<td style="white-space: nowrap">The bank account has already been verified.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>422</code></td>
<td style="white-space: nowrap">BANK_ERROR</td>
<td style="white-space: nowrap">There's an issue with the bank account.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>403</code></td>
<td style="white-space: nowrap">BILLING_ADDRESS_REQUIRED</td>
<td style="white-space: nowrap">In order to create a live mail piece, your account needs to set up a billing address.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>422</code></td>
<td style="white-space: nowrap">CUSTOM_ENVELOPE_INVENTORY_DEPLETED</td>
<td style="white-space: nowrap">Custom envelope inventory is depleted, and more will need to be ordered.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>422</code></td>
<td style="white-space: nowrap">FAILED_DELIVERABILITY_STRICTNESS</td>
<td style="white-space: nowrap">The to address doesn't meet strictness requirements.
See <a href="https://dashboard.lob.com/#/settings/account" target="_blank">Account Settings</a> to configure strictness.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>422</code></td>
<td style="white-space: nowrap">FILE_PAGES_BELOW_MIN</td>
<td style="white-space: nowrap">Not enough pages.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>422</code></td>
<td style="white-space: nowrap">FILE_PAGES_EXCEED_MAX</td>
<td style="white-space: nowrap">Too many pages.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>422</code></td>
<td style="white-space: nowrap">FILE_SIZE_EXCEEDS_LIMIT</td>
<td style="white-space: nowrap">The file size is too large. See description for details.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>422</code></td>
<td style="white-space: nowrap">FOREIGN_RETURN_ADDRESS</td>
<td style="white-space: nowrap">The 'from' address must be a US address.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>422</code></td>
<td style="white-space: nowrap">INCONSISTENT_PAGE_DIMENSIONS</td>
<td style="white-space: nowrap">All pages of the input file must have the same dimensions.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>422</code></td>
<td style="white-space: nowrap">INVALID_BANK_ACCOUNT</td>
<td style="white-space: nowrap">The provided bank routing number is invalid.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>422</code></td>
<td style="white-space: nowrap">INVALID_BANK_ACCOUNT_VERIFICATION</td>
<td style="white-space: nowrap">Verification amounts do not match.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>422</code></td>
<td style="white-space: nowrap">INVALID_CHECK_INTERNATIONAL</td>
<td style="white-space: nowrap">Checks cannot be sent internationally.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>422</code></td>
<td style="white-space: nowrap">INVALID_COUNTRY_COVID</td>
<td style="white-space: nowrap">The postal service in the specified country is currently unable to process the request due to COVID-19 restrictions.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>422</code></td>
<td style="white-space: nowrap">INVALID_FILE</td>
<td style="white-space: nowrap">The file is invalid.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>422</code></td>
<td style="white-space: nowrap">INVALID_FILE_DIMENSIONS</td>
<td style="white-space: nowrap">File dimensions are incorrect for the selected mail type.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>422</code></td>
<td style="white-space: nowrap">INVALID_FILE_DOWNLOAD_TIME</td>
<td style="white-space: nowrap">File download from remote server took too long.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>422</code></td>
<td style="white-space: nowrap">INVALID_FILE_URL</td>
<td style="white-space: nowrap">The file URL when creating a resource is invalid.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>422</code></td>
<td style="white-space: nowrap">INVALID_IMAGE_DPI</td>
<td style="white-space: nowrap">DPI must be at least 300.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>422</code></td>
<td style="white-space: nowrap">INVALID_INTERNATIONAL_FEATURE</td>
<td style="white-space: nowrap">The specified product cannot be sent to the destination.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>422</code></td>
<td style="white-space: nowrap">INVALID_PERFORATION_RETURN_ENVELOPE</td>
<td style="white-space: nowrap">Both `return_envelope` and `perforation` must be used together.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>422</code></td>
<td style="white-space: nowrap">INVALID_TEMPLATE_HTML</td>
<td style="white-space: nowrap">The provided HTML is invalid.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>422</code></td>
<td style="white-space: nowrap">MAIL_USE_TYPE_CAN_NOT_BE_NULL</td>
<td style="white-space: nowrap">`use_type` must be one of "marketing" or "operational". Alternatively, an admin can set the account default use type in Account Settings.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>422</code></td>
<td style="white-space: nowrap">MERGE_VARIABLE_REQUIRED</td>
<td style="white-space: nowrap">A required merge variable is missing.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>422</code></td>
<td style="white-space: nowrap">MERGE_VARIABLE_WHITESPACE</td>
<td style="white-space: nowrap">Merge variable names cannot contain whitespace.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>422</code></td>
<td style="white-space: nowrap">PDF_ENCRYPTED</td>
<td style="white-space: nowrap">An encrypted PDF was provided.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>422</code></td>
<td style="white-space: nowrap">SPECIAL_CHARACTERS_RESTRICTED</td>
<td style="white-space: nowrap">Cannot use special characters for merge variable names.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>422</code></td>
<td style="white-space: nowrap">UNEMBEDDED_FONTS</td>
<td style="white-space: nowrap">The provided PDF contains non-standard unembedded fonts. See description for details.</td>
</tr>
</table>
<div class="back-to-top" ><a href="#" onclick="toTopLink()">back to top</a></div>
- name: Events
description: |
When various notable things happen within the Lob architecture, Events will be created. To get these events sent to your server
automatically when they occur, you can set up [Webhooks](#tag/Webhooks).
<h3>Postcards</h3>
<table>
<tr>
<th style="white-space: nowrap">EVENT TYPE</th>
<th style="white-space: nowrap">LIVE-ONLY</th>
<th style="white-space: nowrap">WHEN EVENT TYPE OCCURS</th>
</tr>
<tr>
<td style="white-space: nowrap"><code>postcard.created</code></td>
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">A postcard is successfully created (Lob returns a 200 status code).</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>postcard.rejected</code></td>
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">A postcard was not successfully created (Usually happens when one or more postcards fail the creation step during a batch request)</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>postcard.rendered_pdf</code></td>
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">A postcard's PDF proof is successfully rendered.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>postcard.rendered_thumbnails</code></td>
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">A postcard's thumbnails are successfully rendered.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>postcard.deleted</code></td>
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">A postcard is successfully canceled.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>postcard.mailed</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A postcard receives a "Mailed" <a href='#operation/tracking_event'>tracking event</a>. Only enabled for certain <a href='https://dashboard.lob.com/#/settings/editions' target="_blank">Print & Mail Editions</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>postcard.in_transit</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A postcard receives an "In Transit" <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>postcard.in_local_area</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A postcard receives an "In Local Area" <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>postcard.processed_for_delivery</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A postcard receives a "Processed for Delivery" <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>postcard.delivered</code></td>
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">A postcard receives a "Delivered" <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>postcard.failed</code></td>
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">A postcard receives a "Failed" <a href="https://help.lob.com/print-and-mail/designing-mail-creatives/creative-formatting/rendering-errors">rendering error</a> or <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>postcard.re-routed</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A postcard receives a "Re-Routed" <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>postcard.returned_to_sender</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A postcard receives a "Returned to Sender" <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>postcard.international_exit</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A postcard receives a "International Exit" <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>postcard.viewed</code></td>
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">A postcard QR code or URL was scanned or viewed by the recipient. </td>
</tr>
</table>
<h3>Self Mailers</h3>
<table>
<tr>
<th style="white-space: nowrap">EVENT TYPE</th>
<th style="white-space: nowrap">LIVE-ONLY</th>
<th style="white-space: nowrap">WHEN EVENT TYPE OCCURS</th>
</tr>
<tr>
<td style="white-space: nowrap"><code>self_mailer.created</code></td>
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">A self_mailer is successfully created (Lob returns a 200 status code).</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>self_mailer.rejected</code></td>
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">A self_mailer was not successfully created (Usually happens when one or more self_mailers fail the creation step during a batch request)</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>self_mailer.rendered_pdf</code></td>
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">A self_mailer's PDF proof is successfully rendered.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>self_mailer.rendered_thumbnails</code></td>
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">A self_mailer's thumbnails are successfully rendered.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>self_mailer.deleted</code></td>
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">A self_mailer is successfully canceled.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>self_mailer.mailed</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A self_mailer receives a "Mailed" <a href='#operation/tracking_event'>tracking event</a>. Only enabled for certain
<a href="https://dashboard.lob.com/#/settings/editions" target="_blank">Print & Mail Editions</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>self_mailer.in_transit</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A self_mailer receives an "In Transit" <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>self_mailer.in_local_area</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A self_mailer receives an "In Local Area" <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>self_mailer.processed_for_delivery</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A self_mailer receives a "Processed for Delivery" <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>self_mailer.delivered</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A self_mailer receives an "Delivered" <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>self_mailer.failed</code></td>
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">A self_mailer receives an "Failed" <a href="https://help.lob.com/print-and-mail/designing-mail-creatives/creative-formatting/rendering-errors">rendering error</a> or <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>self_mailer.re-routed</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A self_mailer receives a "Re-Routed" <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>self_mailer.returned_to_sender</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A self_mailer receives a "Returned to Sender" <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>self_mailer.international_exit</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A self_mailer receives an "International Exit" <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>self_mailer.viewed</code></td>
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">A self_mailer's QR code or URL was scanned or viewed by the recipient. </td>
</tr>
</table>
<h3>Letters</h3>
<table>
<tr>
<th style="white-space: nowrap">EVENT TYPE</th>
<th style="white-space: nowrap">LIVE-ONLY</th>
<th style="white-space: nowrap">WHEN EVENT TYPE OCCURS</th>
</tr>
<tr>
<td style="white-space: nowrap"><code>letter.created</code></td>
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">A letter is successfully created (Lob returns a 200 status code).</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>letter.rejected</code></td>
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">A letter was not successfully created (Usually happens when one or more letters fail the creation step during a batch request)</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>letter.rendered_pdf</code></td>
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">A letter's PDF proof is successfully rendered.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>letter.rendered_thumbnails</code></td>
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">A letter's thumbnails are successfully rendered.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>letter.deleted</code></td>
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">A letter is successfully canceled.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>letter.mailed</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A letter receives a "Mailed" <a href='#operation/tracking_event'>tracking event</a>. Only enabled for certain
<a href="https://dashboard.lob.com/#/settings/editions" target="_blank">Print & Mail Editions</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>letter.in_transit</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A letter receives an "In Transit" <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>letter.in_local_area</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A letter receives an "In Local Area" <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>letter.processed_for_delivery</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A letter receives a "Processed for Delivery" <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>letter.delivered</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A letter receives a "Delivered" <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>letter.failed</code></td>
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">A letter receives a "Failed" <a href="https://help.lob.com/print-and-mail/designing-mail-creatives/creative-formatting/rendering-errors">rendering error</a> or <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>letter.re-routed</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A letter receives a "Re-Routed" <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>letter.returned_to_sender</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A letter receives a "Returned to Sender" <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>letter.international_exit</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A letter receives a "International Exit" <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>letter.viewed</code></td>
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">A letter's QR code or URL was scanned or viewed by the recipient. </td>
</tr>
<tr>
<td style="white-space: nowrap"><code>letter.certified.mailed</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A certified letter receives a "Mailed" <a href='#operation/tracking_event'>tracking event</a>. Only enabled for certain
<a href="https://dashboard.lob.com/#/settings/editions" target="_blank">Print & Mail Editions</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>letter.certified.in_transit</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A certified letter receives an "In Transit" <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>letter.certified.in_local_area</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A certified letter receives an "In Transit" <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>letter.certified.processed_for_delivery</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A certified letter receives a "Processed for Delivery" <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>letter.certified.re-routed</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A certified letter receives a "Re-Routed" <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>letter.certified.returned_to_sender</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A certified letter receives a "Returned to Sender" <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>letter.certified.delivered</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A certified letter receives a "Delivered" <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>letter.certified.pickup_available</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A certified letter receives a "Pickup Available" <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>letter.certified.issue</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A certified letter receives an "Issue" <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>letter.return_envelope.created</code></td>
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">A return envelope is created (occurs simultaneously with letter creation).</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>letter.return_envelope.in_transit</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A return envelope receives an "In Transit" <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>letter.return_envelope.in_local_area</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A return envelope receives an "In Local Area" <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>letter.return_envelope.processed_for_delivery</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A return envelope receives a "Processed for Delivery" <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>letter.return_envelope.re-routed</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A return envelope receives a "Re-Routed" <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>letter.return_envelope.returned_to_sender</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A return envelope receives a "Returned to Sender" <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
</table>
<h3>Checks</h3>
<table>
<tr>
<th style="white-space: nowrap">EVENT TYPE</th>
<th style="white-space: nowrap">LIVE-ONLY</th>
<th style="white-space: nowrap">WHEN EVENT TYPE OCCURS</th>
</tr>
<tr>
<td style="white-space: nowrap"><code>check.created</code></td>
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">A check is successfully created (Lob returns a 200 status code).</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>check.rejected</code></td>
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">A check was not successfully created (Usually happens when one or more checks fail the creation step during a batch request)</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>check.rendered_pdf</code></td>
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">A check's PDF proof is successfully rendered.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>check.rendered_thumbnails</code></td>
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">A check's thumbnails are successfully rendered.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>check.deleted</code></td>
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">A check is successfully canceled.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>check.mailed</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A check receives a "Mailed" <a href='#operation/tracking_event'>tracking event</a>. Only enabled for certain <a href="https://dashboard.lob.com/#/settings/editions" target="_blank">Print & Mail Editions</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>check.in_transit</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A check receives an "In Transit" <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>check.in_local_area</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A check receives an "In Local Area" <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>check.processed_for_delivery</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A check receives a "Processed for Delivery" <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>check.delivered</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A check receives a "Delivered" <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>check.failed</code></td>
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">A check receives a "Failed" <a href="https://help.lob.com/print-and-mail/designing-mail-creatives/creative-formatting/rendering-errors">rendering error</a> or <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>check.re-routed</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A check receives a "Re-Routed" <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>check.returned_to_sender</code></td>
<td style="white-space: nowrap"><code>true</code></td>
<td style="white-space: nowrap">A check receives a "Returned to Sender" <a href='#operation/tracking_event'>tracking event</a>.</td>
</tr>
</table>
<h3>Addresses</h3>
<table>
<tr>
<th style="white-space: nowrap">EVENT TYPE</th>
<th style="white-space: nowrap">LIVE-ONLY</th>
<th style="white-space: nowrap">WHEN EVENT TYPE OCCURS</th>
</tr>
<tr>
<td style="white-space: nowrap"><code>address.created</code></td>
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">An address is successfully created (Lob returns a 200 status code).</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>address.deleted</code></td>
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">An address is successfully deleted.</td>
</tr>
</table>
<h3>Bank Accounts</h3>
<table>
<tr>
<th style="white-space: nowrap">EVENT TYPE</th>
<th style="white-space: nowrap">LIVE-ONLY</th>
<th style="white-space: nowrap">WHEN EVENT TYPE OCCURS</th>
</tr>
<tr>
<td style="white-space: nowrap"><code>bank_account.created</code></td>
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">A bank account is successfully created (Lob returns a 200 status code).</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>bank_account.deleted</code></td>
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">A bank account is successfully deleted.</td>
</tr>
<tr>
<td style="white-space: nowrap"><code>bank_account.verified</code></td>
<td style="white-space: nowrap"><code>false</code></td>
<td style="white-space: nowrap">A bank account is successfully verified.</td>
</tr>
</table>
<div class="back-to-top" ><a href="#" onclick="toTopLink()">back to top</a></div>
- name: Getting Started
x-traitTag: true
description: |
### 1. Get Setup
* Create an account at <a href="https://dashboard.lob.com/#/register" target="_blank">Lob.com</a>
* Obtain your API keys in the Lob dashboard <a href="https://dashboard.lob.com/settings/api-keys" target="_blank">settings</a>
* You'll use the format, `test_*.` for your Test API key and `live_*.` for your Live API key.
### 2. Explore
* Try out in Postman:
<div class="postman-run-button"
data-postman-action="collection/fork"
data-postman-var-1="16169677-975ecb9f-ea22-4d8f-a4f9-53a42f2aee03"
data-postman-collection-url="entityId=16169677-975ecb9f-ea22-4d8f-a4f9-53a42f2aee03&entityType=collection&workspaceId=5404d3a5-5a84-4df6-b078-a1547e1a68a7"
style="background:#0099d7;color: white;display: flex;justify-content: center;align-items: center;">
Run in Postman
</div>
<script type="text/javascript">
(function (p,o,s,t,m,a,n) {
!p[s] && (p[s] = function () { (p[t] || (p[t] = [])).push(arguments); });
!o.getElementById(s+t) && o.getElementsByTagName("head")[0].appendChild((
(n = o.createElement("script")),
(n.id = s+t), (n.async = 1), (n.src = m), n
));
}(window, document, "_pm", "PostmanRunObject", "https://run.pstmn.io/button.js"));
</script>
* Launch your terminal and copy/paste a CURL command.
```bash
curl https://api.lob.com/v1/addresses \
-u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
```
* Download a [Lob SDK](#tag/SDKs-and-Tools) into your favorite IDE (integrated development environment)
### 3. Learn more
Try our quick start (TypeScript, Python, PHP, Java or Ruby):
* <a href="https://help.lob.com/developer-docs/quickstart-guide" target="_blank">Send your first Postcards</a>
Use Case guides
* <a href="https://help.lob.com/developer-docs/use-case-guides/mass-deletion-setup" target="_blank">Mass Deletion Setup</a>
* <a href="https://help.lob.com/developer-docs/use-case-guides/ncoa-restrictions" target="_blank">NCOA Restrictions</a>
* <a href="https://help.lob.com/developer-docs/use-case-guides/override-cancellation-window" target="_blank">Override Cancellation Window</a>
* <a href="https://help.lob.com/developer-docs/use-case-guides/visibility-of-address-changes" target="_blank">Visibility of Address Changes</a>
* <a href="https://help.lob.com/developer-docs/use-case-guides/ingesting-tracking-events-with-webhooks" target="_blank">Ingesting Tracking Events with Webhooks</a>
<div class="back-to-top" ><a href="#" onclick="toTopLink()">back to top</a></div>
- name: Identity Validation
description: |
Validates whether a given name is associated with an address.
<div class="back-to-top" ><a href="#" onclick="toTopLink()">back to top</a></div>
- name: Informed Delivery Campaign
description: |
The Informed Delivery campaigns API allows you to create and view Informed Delivery campaigns.
<div class="back-to-top" ><a href="#" onclick="toTopLink()">back to top</a></div>
- name: Intl Autocompletions
description: |
Address autocompletion for non-US addresses. Given partial address information, this endpoint returns up to 10 address suggestions.
## Autocompletion Test Env
Your test API key does not autocomplete international addresses and is used to simulate
behavior. With your test API key, requests with specific values for `address_prefix`
return predetermined values. When `address_prefix` is set to:
- `0 suggestions` - Returns no suggestions
- `[PRIMARY NUMBER] s[uggestion]` - Returns a maximum of ten predefined suggested addresses.
`[PRIMARY NUMBER]` does not have to be a valid primary number when sending a test request.
Each additional letter in `suggestion` reduces the number of suggestions by one (e.g.
`1 su` returns 9 suggested addresses). `[PRIMARY NUMBER]` does not affect the number of
suggestions returned.
Country is a required field.