-
Notifications
You must be signed in to change notification settings - Fork 0
/
lithic-openapi.yml
18965 lines (18895 loc) · 714 KB
/
lithic-openapi.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.1.0
info:
contact:
email: [email protected]
description: |
The Lithic Developer API is designed to provide a predictable programmatic interface for accessing your Lithic account through an API and transaction webhooks.
Note that your API key is a secret and should be treated as such. Don't share it with anyone, including us. We will never ask you for it.
termsOfService: https://lithic.com/legal#terms
title: Lithic Developer API
version: 1.0.0
servers:
- description: Sandbox environment that provides key functionality mirroring production
url: https://sandbox.lithic.com
security:
- ApiKeyAuth: []
tags:
- name: 3DS
- name: Account
- name: Book Transfer
- name: Account Holder
- name: Auth Stream Access (ASA)
- name: Authorization Rules
- name: Balance
- name: Card
- name: Credit Product
- name: Dispute
- name: Event
- name: External Bank Account
- name: External Payments
- name: Financial Account
- name: Management Operations
- name: Payment
- name: Responder Endpoints
- name: Settlement Report
- name: Statements
- name: Status
- name: Tokenization
- name: Transaction
paths:
/v1/account_holders:
get:
description: Get a list of individual or business account holders and their KYC or KYB evaluation status.
operationId: getAccountHolders
parameters:
- description: If applicable, represents the external_id associated with the account_holder.
example: 00000000-0000-0000-0000-000000000001
in: query
name: external_id
schema:
format: uuid
type: string
- description: The number of account_holders to limit the response to.
example: 10
in: query
name: limit
schema:
type: integer
- description: (Individual Account Holders only) The first name of the account holder. The query is case insensitive and supports partial matches.
example: John
in: query
name: first_name
schema:
type: string
- description: (Individual Account Holders only) The last name of the account holder. The query is case insensitive and supports partial matches.
example: Appleseed
in: query
name: last_name
schema:
type: string
- description: (Business Account Holders only) The legal business name of the account holder. The query is case insensitive and supports partial matches.
example: Busy Business, Inc.
in: query
name: legal_business_name
schema:
type: string
- description: Phone number of the account holder. The query must be an exact match.
example: 5555555555
in: query
name: phone_number
schema:
type: string
- description: Email address of the account holder. The query must be an exact match, case insensitive.
example: [email protected]
in: query
name: email
schema:
type: string
- $ref: '#/components/parameters/endingBefore'
- $ref: '#/components/parameters/startingAfter'
- $ref: '#/components/parameters/beginTime'
- $ref: '#/components/parameters/endTime'
responses:
'200':
content:
application/json:
examples:
getAccountHoldersResponse:
value:
data:
- account_token: 6b67b340-ed11-4463-a33d-0d7f7fdcd28c
business_account_token: 00000000-0000-0000-0000-000000000000
created: '2024-01-11T19:50:36.105448'
email: [email protected]
exemption_type: AUTHORIZED_USER
external_id: '5555555555'
individual:
address:
address1: 123 Main Street
city: New York
country: USA
postal_code: '10128'
state: NY
dob: '2000-01-01'
email: [email protected]
first_name: John
last_name: Appleseed
phone_number: '5555555555'
entity_token: 49c978db-20c4-46d8-9db4-b0ef28c03533
phone_number: '5555555555'
status: ACCEPTED
token: b68b7424-aa69-4cbc-a946-30d90181b621
user_type: INDIVIDUAL
verification_application:
created: '2024-01-11T19:58:24.821848'
status: ACCEPTED
status_reasons: []
updated: '2024-01-11T19:58:24.821848'
- account_token: 732f7328-a2d7-4281-a264-e8cb5af8d392
beneficial_owner_entities:
- address:
address1: 22 Street North
city: New York
country: US
postal_code: '10004'
state: NY
dba_business_name: Busy Business, Inc.
government_id: 98-7654321
legal_business_name: Busy Business, Inc.
parent_company: Example company
phone_numbers:
- '5555555555'
entity_token: d89185ca-1fad-4f33-905c-416b4270a5d4
business_account_token: 00000000-0000-0000-0000-000000000000
business_entity:
address:
address1: 22 Street North
city: New York
country: US
postal_code: '10004'
state: NY
dba_business_name: Busy Business, Inc.
government_id: 98-7654321
legal_business_name: Busy Business, Inc.
parent_company: Example company
phone_numbers:
- '5555555555'
entity_token: f360a3c0-24e6-4852-ae82-27916a5c4e86
control_person:
address:
address1: 451 New Forest Way
city: Springfield
country: US
postal_code: '68022'
state: IL
dob: '1991-03-08T08:00:00Z'
email: [email protected]
first_name: John
last_name: Appleseed
phone_number: '5555555555'
entity_token: 9d657ba0-7c8a-4946-a596-f99d978a4137
created: '2024-01-11T19:50:36.105449'
exemption_type: AUTHORIZED_USER
external_id: 851030f1-9b7b-4939-8ac9-161bd972d26f
token: fa68ed76-9d02-4d45-8a3f-782f3b6a8b3f
user_type: BUSINESS
verification_application:
created: '2024-01-11T19:50:36.105449'
status: PENDING_REVIEW
status_reasons: []
updated: '2024-01-11T19:50:36.105449'
has_more: false
schema:
properties:
data:
items:
$ref: '#/components/schemas/AccountHolder'
type: array
has_more:
description: Whether there are more accounts to be retrieved.
type: boolean
required:
- data
- has_more
type: object
description: OK
'401':
$ref: '#/components/responses/Unauthorized'
'429':
$ref: '#/components/responses/TooManyRequests'
summary: Get a list of individual or business account holders
tags:
- Account Holder
post:
description: |-
Run an individual or business's information through the Customer Identification Program (CIP).
All calls to this endpoint will return an immediate response - though in some cases, the response may indicate the enrollment is under review or further action will be needed to complete the account enrollment process.
This endpoint can only be used on accounts that are part of the program that the calling API key manages.
operationId: postAccountHolders
requestBody:
content:
application/json:
examples:
kybRequest:
summary: Create an account holder with KYB workflow
value:
beneficial_owner_entities:
- address:
address1: 300 Normal Forest Way
city: Portland
country: USA
postal_code: '90210'
state: OR
dba_name: MHoldings
entity_type: LLC
government_id: 98-7654321
incorporation_country: US
incorporation_date: '2015-09-17'
incorporation_state: NV
legal_business_name: Majority Holdings LLC
phone_numbers:
- '+12124007676'
beneficial_owner_individuals:
- address:
address1: 300 Normal Forest Way
city: Portland
country: USA
postal_code: '90210'
state: OR
dob: '1991-03-08T08:00:00Z'
email: [email protected]
first_name: Timmy
government_id: 211-23-1412
last_name: Turner
phone_number: '+12024007611'
business_entity:
address:
address1: 123 Old Forest Way
city: Omaha
country: USA
postal_code: '61022'
state: NE
dba_name: Example Business Solutions
entity_type: Corporation
government_id: 12-3456789
incorporation_country: US
incorporation_date: '2010-06-28'
incorporation_state: DE
legal_business_name: Busy Business, Inc.
phone_numbers:
- '+12124007676'
control_person:
address:
address1: 451 New Forest Way
city: Springfield
country: USA
postal_code: '68022'
state: IL
birthdate: '1980-04-12'
dob: '1991-03-08T08:00:00Z'
email: [email protected]
first_name: Tom
government_id: 111-23-1412
last_name: Timothy
nationality: US
phone_number: '+12024008176'
title: CEO
kyb_passed_timestamp: '2022-03-08T08:00:00Z'
nature_of_business: Software company selling solutions to the restaurant industry
tos_timestamp: '2022-03-08T08:00:00Z'
website_url: https://www.mybusiness.com
workflow: KYB_BASIC
kycExemptRequest:
summary: Create an account holder with KYC Exempt workflow
value:
address:
address1: 123 Old Forest Way
city: Omaha
country: USA
postal_code: '68022'
state: NE
business_account_token: e87db14a-4abf-4901-adad-5d5c9f46aff2
email: [email protected]
first_name: Tom
kyc_exemption_type: AUTHORIZED_USER
last_name: Bombadil
phone_number: '+12124007676'
workflow: KYC_EXEMPT
kycRequest:
summary: Create an account holder with KYC workflow
value:
individual:
address:
address1: 123 Old Forest Way
city: Omaha
country: USA
postal_code: '68022'
state: NE
dob: '1991-03-08 08:00:00'
email: [email protected]
first_name: Tom
government_id: 111-23-1412
last_name: Bombadil
phone_number: '+12124007676'
tos_timestamp: '2022-03-08 08:00:00'
workflow: KYC_ADVANCED
schema:
oneOf:
- $ref: '#/components/schemas/Kyb'
- $ref: '#/components/schemas/Kyc'
- $ref: '#/components/schemas/KycExempt'
required: true
responses:
'200':
content:
application/json:
examples:
acceptedEvaluationResponse:
summary: Accepted KYC/KYB evaluation response
value:
account_token: b68b7424-aa69-4cbc-a946-30d90181b621
business_account_token: e87db14a-4abf-4901-adad-5d5c9f46aff2
status: ACCEPTED
status_reasons: []
token: 12345678-aa69-4cbc-a946-30d90181b621
created: '2024-09-16T20:13:41.865274'
pendingResubmitResponse:
summary: Pending resubmit KYC evaluation response
value:
account_token: b68b7424-aa69-4cbc-a946-30d90181b621
status: PENDING_RESUBMIT
status_reasons:
- NAME_VERIFICATION_FAILURE
token: 12345678-aa69-4cbc-a946-30d90181b621
created: '2024-09-16T20:13:41.865274'
pendingKYBReviewResponse:
summary: Pending review response for a KYB_BASIC request
value:
account_token: 6016af53-87d4-42aa-b021-0170644d6458
status: PENDING_REVIEW
status_reasons:
- PRIMARY_BUSINESS_ENTITY_ADDRESS_VERIFICATION_FAILURE
token: 12345678-aa69-4cbc-a946-30d90181b621
created: '2024-09-16T20:13:41.865274'
required_documents:
- entity_token: 48afea0a-38b0-44e4-aaa7-c2b5413da9d3
valid_documents:
- EIN_LETTER
- TAX_RETURN
- CERTIFICATE_OF_GOOD_STANDING
- ARTICLES_OF_INCORPORATION
- ARTICLES_OF_ORGANIZATION
- CERTIFICATE_OF_FORMATION
- BYLAWS
- GOVERNMENT_BUSINESS_LICENSE
- PARTNERSHIP_AGREEMENT
- BANK_STATEMENT
- UTILITY_BILL_STATEMENT
status_reasons:
- PRIMARY_BUSINESS_ENTITY_ADDRESS_VERIFICATION_FAILURE
schema:
properties:
account_token:
description: Globally unique identifier for the account.
format: uuid
type: string
created:
description: Timestamp of when the account holder was created.
format: date-time
type: string
external_id:
description: Customer-provided token that indicates a relationship with an object outside of the Lithic ecosystem.
format: string
type: string
status:
description: |
KYC and KYB evaluation states.
Note:
* `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the `KYC_ADVANCED` workflow.
* `PENDING_REVIEW` is only applicable for the `KYB_BASIC` workflow.
enum:
- ACCEPTED
- PENDING_REVIEW
- PENDING_DOCUMENT
- PENDING_RESUBMIT
- REJECTED
type: string
status_reasons:
description: Reason for the evaluation status.
items:
enum:
- ADDRESS_VERIFICATION_FAILURE
- AGE_THRESHOLD_FAILURE
- COMPLETE_VERIFICATION_FAILURE
- DOB_VERIFICATION_FAILURE
- ID_VERIFICATION_FAILURE
- MAX_DOCUMENT_ATTEMPTS
- MAX_RESUBMISSION_ATTEMPTS
- NAME_VERIFICATION_FAILURE
- OTHER_VERIFICATION_FAILURE
- RISK_THRESHOLD_FAILURE
- WATCHLIST_ALERT_FAILURE
type: string
type: array
required_documents:
description: Only present for "KYB_BASIC" and "KYC_ADVANCED" workflows. A list of documents required for the account holder to be approved.
type: array
items:
$ref: '#/components/schemas/required-document'
token:
description: Globally unique identifier for the account holder.
format: uuid
type: string
required:
- account_token
- status
- status_reasons
- token
type: object
description: OK
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'429':
$ref: '#/components/responses/TooManyRequests'
summary: Create an individual or business account holder
tags:
- Account Holder
/v1/account_holders/{account_holder_token}:
get:
description: Get an Individual or Business Account Holder and/or their KYC or KYB evaluation status.
operationId: getAccountHolder
parameters:
- $ref: '#/components/parameters/accountHolderTokenPath'
responses:
'200':
content:
application/json:
examples:
kycAcceptedReview:
summary: Accepted KYC evaluation response
value:
token: b68b7424-aa69-4cbc-a946-30d90181b621
account_token: 6b67b340-ed11-4463-a33d-0d7f7fdcd28c
business_account_token: 5310469f-3a16-44ce-89f8-cdc4446fcfdf
external_id: ''
created: '2024-01-11T19:50:36.105449'
user_type: INDIVIDUAL
exemption_type: ''
verification_application:
created: '2024-01-11T19:50:36.105449'
updated: '2024-01-11T19:50:36.105449'
status: ACCEPTED
status_reasons: []
individual:
address:
address1: 451 New Forest Way
city: Springfield
state: IL
postal_code: '68022'
country: US
dob: '1991-03-08T08:00:00Z'
email: [email protected]
first_name: John
last_name: Appleseed
phone_number: '5555555555'
entity_token: fd771a07-c5c2-42f3-a53c-a6c79c6c0d07
email: [email protected]
phone_number: '5555555555'
status: ACCEPTED
kybBasicPendingReview:
summary: Pending review submission for a KYB_BASIC account_holder
value:
token: fa68ed76-9d02-4d45-8a3f-782f3b6a8b3f
account_token: 732f7328-a2d7-4281-a264-e8cb5af8d392
business_account_token: 00000000-0000-0000-0000-000000000000
external_id: ''
created: '2024-01-11T19:50:36.105449'
user_type: BUSINESS
exemption_type: ''
verification_application:
created: '2024-01-11T19:50:36.105449'
updated: '2024-01-11T19:50:36.105449'
status: PENDING_REVIEW
status_reasons:
- PRIMARY_BUSINESS_ENTITY_ADDRESS_VERIFICATION_FAILURE
required_documents:
- entity_token: 83cf25ae-c14f-4d10-9fa2-0119f36c7286
status_reasons:
- PRIMARY_BUSINESS_ENTITY_ADDRESS_VERIFICATION_FAILURE
valid_documents:
- EIN_LETTER
- TAX_RETURN
- CERTIFICATE_OF_GOOD_STANDING
- ARTICLES_OF_INCORPORATION
- ARTICLES_OF_ORGANIZATION
- CERTIFICATE_OF_FORMATION
- BYLAWS
- GOVERNMENT_BUSINESS_LICENSE
- PARTNERSHIP_AGREEMENT
- BANK_STATEMENT
- UTILITY_BILL_STATEMENT
business_entity:
address:
address1: 22 Street North
city: New York
state: NY
postal_code: '10004'
country: US
dba_business_name: Busy Business, Inc.
government_id: 98-7654321
legal_business_name: Busy Business, Inc.
parent_company: Example company
phone_numbers:
- '5555555555'
entity_token: 05cc03c9-dea6-4d17-a11e-0f3ea57d51a5
control_person:
address:
address1: 451 New Forest Way
city: Springfield
state: IL
postal_code: '68022'
country: US
dob: '1991-03-08T08:00:00Z'
email: [email protected]
first_name: John
last_name: Appleseed
phone_number: '5555555555'
entity_token: fd771a07-c5c2-42f3-a53c-a6c79c6c0d07
beneficial_owner_entities:
- address:
address1: 22 Street North
city: New York
state: NY
postal_code: '10004'
country: US
dba_business_name: Busy Business, Inc.
government_id: 98-7654321
legal_business_name: Busy Business, Inc.
parent_company: Example company
phone_numbers:
- '5555555555'
entity_token: 2b3cdab5-c866-408f-85bc-e707015ee409
schema:
$ref: '#/components/schemas/AccountHolder'
description: OK
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
'429':
$ref: '#/components/responses/TooManyRequests'
summary: Get an individual or business account holder
tags:
- Account Holder
patch:
description: Update the information associated with a particular account holder.
operationId: patchAccountHolder
parameters:
- $ref: '#/components/parameters/accountHolderTokenPath'
requestBody:
content:
application/json:
schema:
properties:
business_account_token:
description: Only applicable for customers using the KYC-Exempt workflow to enroll authorized users of businesses. Pass the account_token of the enrolled business associated with the AUTHORIZED_USER in this field.
type: string
email:
description: Account holder's email address. The primary purpose of this field is for cardholder identification and verification during the digital wallet tokenization process.
type: string
phone_number:
description: Account holder's phone number, entered in E.164 format. The primary purpose of this field is for cardholder identification and verification during the digital wallet tokenization process.
type: string
type: object
required: true
responses:
'200':
content:
application/json:
schema:
properties:
business_account_token:
description: Only applicable for customers using the KYC-Exempt workflow to enroll businesses with authorized users. Pass the account_token of the enrolled business associated with the AUTHORIZED_USER in this field.
type: string
email:
description: The newly updated email for the account holder
type: string
phone_number:
description: The newly updated phone_number for the account holder
type: string
token:
description: The token for the account holder that was updated
type: string
type: object
description: OK
'404':
$ref: '#/components/responses/NotFound'
summary: Update account holder information
tags:
- Account Holder
/v1/account_holders/{account_holder_token}/documents:
get:
description: |
Retrieve the status of account holder document uploads, or retrieve the upload URLs to process your image uploads.
Note that this is not equivalent to checking the status of the KYC evaluation overall (a document may be successfully uploaded but not be sufficient for KYC to pass).
In the event your upload URLs have expired, calling this endpoint will refresh them.
Similarly, in the event a previous account holder document upload has failed, you can use this endpoint to get a new upload URL for the failed image upload.
When a new document upload is generated for a failed attempt, the response will show an additional entry in the `required_document_uploads` list
in a `PENDING` state for the corresponding `image_type`.
operationId: getAccountHolderDocuments
parameters:
- $ref: '#/components/parameters/accountHolderTokenPath'
responses:
'200':
content:
application/json:
schema:
properties:
data:
items:
$ref: '#/components/schemas/document'
type: array
type: object
description: OK
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'429':
$ref: '#/components/responses/TooManyRequests'
summary: Get account holder document uploads
tags:
- Account Holder
post:
description: |
Use this endpoint to identify which type of supported government-issued documentation you will upload for further verification.
It will return two URLs to upload your document images to - one for the front image and one for the back image.
This endpoint is only valid for evaluations in a `PENDING_DOCUMENT` state.
Uploaded images must either be a `jpg` or `png` file, and each must be less than 15 MiB. Once both required uploads have been successfully completed, your document will be run through KYC verification.
If you have registered a webhook, you will receive evaluation updates for any document submission evaluations, as well as for any failed document uploads.
Two document submission attempts are permitted via this endpoint before a `REJECTED` status is returned and the account creation process is ended. Currently only one type of
account holder document is supported per KYC verification.
operationId: postAccountHolderDocuments
parameters:
- $ref: '#/components/parameters/accountHolderTokenPath'
requestBody:
content:
application/json:
examples:
recieveLinkForDriversLicense:
summary: Initiate account holder document upload
value:
document_type: EIN_LETTER
schema:
properties:
document_type:
description: The type of document to upload
enum:
- EIN_LETTER
- TAX_RETURN
- OPERATING_AGREEMENT
- CERTIFICATE_OF_FORMATION
- DRIVERS_LICENSE
- PASSPORT
- PASSPORT_CARD
- CERTIFICATE_OF_GOOD_STANDING
- ARTICLES_OF_INCORPORATION
- ARTICLES_OF_ORGANIZATION
- BYLAWS
- GOVERNMENT_BUSINESS_LICENSE
- PARTNERSHIP_AGREEMENT
- SS4_FORM
- BANK_STATEMENT
- UTILITY_BILL_STATEMENT
- SSN_CARD
- ITIN_LETTER
type: string
entity_token:
description: Globally unique identifier for the entity.
type: string
format: uuid
required:
- document_type
- entity_token
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/document'
description: OK
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'409':
$ref: '#/components/responses/Conflict'
'429':
$ref: '#/components/responses/TooManyRequests'
summary: Initiate account holder document upload
tags:
- Account Holder
/v1/account_holders/{account_holder_token}/documents/{document_token}:
get:
description: |
Check the status of an account holder document upload, or retrieve the upload URLs to process your image uploads.
Note that this is not equivalent to checking the status of the KYC evaluation overall (a document may be successfully uploaded but not be sufficient for KYC to pass).
In the event your upload URLs have expired, calling this endpoint will refresh them.
Similarly, in the event a document upload has failed, you can use this endpoint to get a new upload URL for the failed image upload.
When a new account holder document upload is generated for a failed attempt, the response will show an additional entry in the `required_document_uploads` array
in a `PENDING` state for the corresponding `image_type`.
operationId: getAccountHolderDocumentByToken
parameters:
- $ref: '#/components/parameters/accountHolderTokenPath'
- $ref: '#/components/parameters/documentToken'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/document'
description: OK
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
summary: Get account holder document upload status
tags:
- Account Holder
/v1/account_holders/{account_holder_token}/resubmit:
post:
description: |
Resubmit a KYC submission. This endpoint should be used in cases where a KYC submission returned a `PENDING_RESUBMIT` result,
meaning one or more critical KYC fields may have been mis-entered and the individual's identity has not yet been successfully verified.
This step must be completed in order to proceed with the KYC evaluation.
Two resubmission attempts are permitted via this endpoint before a `REJECTED` status is returned and the account creation process is ended.
operationId: postAccountHolderResubmit
parameters:
- $ref: '#/components/parameters/accountHolderTokenPath'
requestBody:
content:
application/json:
schema:
properties:
individual:
$ref: '#/components/schemas/KycIndividual'
description: Information on individual for whom the account is being opened and KYC is being re-run.
tos_timestamp:
description: An RFC 3339 timestamp indicating when the account holder accepted the applicable legal agreements (e.g., cardholder terms) as agreed upon during API customer's implementation with Lithic.
example: '2022-03-08 08:00:00'
type: string
workflow:
default: KYC_ADVANCED
enum:
- KYC_ADVANCED
type: string
required:
- individual
- tos_timestamp
- workflow
type: object
required: true
responses:
'200':
content:
application/json:
examples:
acceptedEvaluationResponse:
summary: Accepted KYC evaluation response
value:
account_token: b68b7424-aa69-4cbc-a946-30d90181b621
status: ACCEPTED
status_reasons: []
token: 12345678-aa69-4cbc-a946-30d90181b621
maxSubmissions:
summary: KYC rejected for too many resubmissions
value:
account_token: b68b7424-aa69-4cbc-a946-30d90181b621
status: REJECTED
status_reasons:
- MAX_RESUBMISSION_ATTEMPTS
token: 12345678-aa69-4cbc-a946-30d90181b621
schema:
$ref: '#/components/schemas/AccountHolder'
description: OK
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'409':
$ref: '#/components/responses/Conflict'
'429':
$ref: '#/components/responses/TooManyRequests'
summary: Resubmit account holder information
tags:
- Account Holder
/v1/accounts:
get:
description: |
List account configurations.
operationId: getAccounts
parameters:
- $ref: '#/components/parameters/beginTime'
- $ref: '#/components/parameters/endTime'
- $ref: '#/components/parameters/endingBefore'
- $ref: '#/components/parameters/pageSize'
- $ref: '#/components/parameters/startingAfter'
responses:
'200':
content:
application/json:
examples:
getAccounts:
summary: List accounts
value:
data:
- cardholder_currency: USD
spend_limit:
daily: 1000
lifetime: 10000
monthly: 4000
state: ACTIVE
token: b68b7424-aa69-4cbc-a946-30d90181b621
has_more: false
schema:
properties:
data:
items:
$ref: '#/components/schemas/AccountConfiguration'
type: array
has_more:
description: Whether there are more accounts to be retrieved.
type: boolean
required:
- data
- has_more
type: object
description: OK
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
'429':
$ref: '#/components/responses/TooManyRequests'
summary: List accounts
tags:
- Account
/v1/accounts/{account_token}:
get:
description: Get account configuration such as spend limits.
operationId: getAccountByToken
parameters:
- $ref: '#/components/parameters/accountToken'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AccountConfiguration'
description: OK
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
'429':
$ref: '#/components/responses/TooManyRequests'
summary: Get account
tags:
- Account
patch:
description: |
Update account configuration such as spend limits and verification address. Can only be run on accounts that are part of the program managed by this API key.
Accounts that are in the `PAUSED` state will not be able to transact or create new cards.
operationId: patchAccountByToken
parameters:
- $ref: '#/components/parameters/accountToken'
requestBody:
content:
application/json:
examples:
setDailySpendLimit:
summary: Update daily spend limit
value:
daily_spend_limit: 1000
schema:
properties:
daily_spend_limit:
default: 125000
description: |
Amount (in cents) for the account's daily spend limit.
By default the daily spend limit is set to $1,250.
minimum: 0
type: integer
lifetime_spend_limit:
default: 0
description: |
Amount (in cents) for the account's lifetime spend limit. Once this limit is reached, no transactions will be accepted on any card created for this account until the limit is updated.
Note that a spend limit of 0 is effectively no limit, and should only be used to reset or remove a prior limit. Only a limit of 1 or above will result in declined transactions due to checks against the account limit. This behavior differs from the daily spend limit and the monthly spend limit.
minimum: 0
type: integer
monthly_spend_limit:
default: 500000
description: |
Amount (in cents) for the account's monthly spend limit.
By default the monthly spend limit is set to $5,000.
minimum: 0
type: integer
state:
description: Account states.
enum:
- ACTIVE
- PAUSED
type: string
verification_address:
description: Address used during Address Verification Service (AVS) checks during transactions if enabled via Auth Rules.
properties:
address1:
type: string
address2:
type: string
city:
type: string
country:
type: string
postal_code:
type: string
state:
type: string
type: object
type: object
required: true
responses:
'200':
content:
application/json:
examples:
exampleResponse:
value:
cardholder_currency: USD
spend_limit:
daily: 1000
lifetime: 100000
monthly: 40000
state: ACTIVE
token: ecbd1d58-0299-48b3-84da-6ed7f5bf9ec1
verification_address:
address1: 5 Broad Street
address2: ''
city: New York
country: USA
postal_code: '10001'
state: NY
schema:
$ref: '#/components/schemas/AccountConfiguration'
description: OK
'400':
$ref: '#/components/responses/BadRequest'