@borrowbetter/arpcsdk 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,2854 @@
1
+ interface RequestConfig {
2
+ url: string;
3
+ method: string;
4
+ params?: Record<string, unknown>;
5
+ data?: unknown;
6
+ headers?: Record<string, string>;
7
+ signal?: AbortSignal;
8
+ responseType?: string;
9
+ }
10
+ interface HttpResponse<T> {
11
+ status: number;
12
+ data: T;
13
+ headers: Headers;
14
+ }
15
+
16
+ interface TokenResponse {
17
+ access_token: string;
18
+ token_type?: string;
19
+ expires_in?: number;
20
+ }
21
+
22
+ /**
23
+ * SDK configuration.
24
+ *
25
+ * The library never reads the environment itself — a consumer constructs
26
+ * `new ArpcSDK(config)`, which calls `configure()`. The `configFromEnv()` helper
27
+ * is a convenience for the dev scripts (smoke / server), which load `.env` via
28
+ * dotenv-flow and pass the result in.
29
+ */
30
+ interface ArpcConfig {
31
+ /** OAuth host — token exchange only (`POST /v1/token`). */
32
+ oauthUrl: string;
33
+ /** API gateway host — every non-auth call. */
34
+ gatewayUrl: string;
35
+ /**
36
+ * OAuth client_id (HTTP Basic username). Also used as the lead's
37
+ * `seller_agent_email` — the OAuth identity is a registered DRA agent.
38
+ */
39
+ username: string;
40
+ /** OAuth client_secret (HTTP Basic password). */
41
+ password: string;
42
+ }
43
+
44
+ /**
45
+ * Generated by orval v7.21.0 🍺
46
+ * Do not edit manually.
47
+ * ARPC — Achieve Resolution Partner Connect API
48
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
49
+ * OpenAPI spec version: 2026.15.0
50
+ */
51
+ /**
52
+ * Stable machine-readable reason for the violation. See ValidationReasonCode.
53
+ */
54
+ type FieldValidationErrorReasonCode = typeof FieldValidationErrorReasonCode[keyof typeof FieldValidationErrorReasonCode];
55
+ declare const FieldValidationErrorReasonCode: {
56
+ readonly REQUIRED: "REQUIRED";
57
+ readonly INVALID_FORMAT: "INVALID_FORMAT";
58
+ readonly OUT_OF_RANGE: "OUT_OF_RANGE";
59
+ readonly INVALID_VALUE: "INVALID_VALUE";
60
+ readonly UNDERAGE: "UNDERAGE";
61
+ readonly CONFLICT: "CONFLICT";
62
+ };
63
+
64
+ /**
65
+ * Generated by orval v7.21.0 🍺
66
+ * Do not edit manually.
67
+ * ARPC — Achieve Resolution Partner Connect API
68
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
69
+ * OpenAPI spec version: 2026.15.0
70
+ */
71
+
72
+ /**
73
+ * Single field-level validation violation
74
+ */
75
+ interface FieldValidationError {
76
+ /** Dotted JSON path of the offending request field */
77
+ field?: string;
78
+ /** Stable machine-readable reason for the violation. See ValidationReasonCode. */
79
+ reason_code?: FieldValidationErrorReasonCode;
80
+ /** Free-text reason suitable for display (without the field prefix) */
81
+ message?: string;
82
+ }
83
+
84
+ /**
85
+ * Generated by orval v7.21.0 🍺
86
+ * Do not edit manually.
87
+ * ARPC — Achieve Resolution Partner Connect API
88
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
89
+ * OpenAPI spec version: 2026.15.0
90
+ */
91
+
92
+ /**
93
+ * Unified DEX error response body
94
+ */
95
+ interface ARPCErrorResponse {
96
+ /** HTTP status code */
97
+ status?: number;
98
+ /** ARPC error classification code */
99
+ error_code?: string;
100
+ /** Human-readable error sentence */
101
+ error?: string;
102
+ /** Field-level violations. Present only for field-validation failures (e.g. ER40001, ER00400); absent for upstream, auth, or internal errors. */
103
+ errors?: FieldValidationError[];
104
+ /** Free-text reason for non-field-validation failures (upstream rejection, auth failure, internal error). Absent when 'errors[]' is populated. */
105
+ message?: string;
106
+ /** ISO-8601 UTC timestamp of when the error occurred */
107
+ timestamp?: string;
108
+ /** Correlation ID for distributed tracing across services */
109
+ x_correlation_id?: string;
110
+ }
111
+
112
+ /**
113
+ * Generated by orval v7.21.0 🍺
114
+ * Do not edit manually.
115
+ * ARPC — Achieve Resolution Partner Connect API
116
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
117
+ * OpenAPI spec version: 2026.15.0
118
+ */
119
+ /**
120
+ * Street address
121
+ */
122
+ interface Address {
123
+ /** Street line 1 */
124
+ line1?: string;
125
+ /** City */
126
+ city?: string;
127
+ /** Two-letter US state code */
128
+ state?: string;
129
+ /** Country */
130
+ country?: string;
131
+ /** ZIP code */
132
+ zip_code?: string;
133
+ }
134
+
135
+ /**
136
+ * Generated by orval v7.21.0 🍺
137
+ * Do not edit manually.
138
+ * ARPC — Achieve Resolution Partner Connect API
139
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
140
+ * OpenAPI spec version: 2026.15.0
141
+ */
142
+ /**
143
+ * Address used by v2. ZIP is exposed as zip_code on the public request.
144
+ */
145
+ interface RegisterApplicantV2Address {
146
+ /** Street address line 1 */
147
+ line1?: string;
148
+ /** City */
149
+ city: string;
150
+ /** US state code — 2 characters */
151
+ state: string;
152
+ /** 5-digit ZIP code */
153
+ zip_code?: string;
154
+ /** Country code */
155
+ country?: string;
156
+ }
157
+
158
+ /**
159
+ * Generated by orval v7.21.0 🍺
160
+ * Do not edit manually.
161
+ * ARPC — Achieve Resolution Partner Connect API
162
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
163
+ * OpenAPI spec version: 2026.15.0
164
+ */
165
+
166
+ /**
167
+ * Applicant details
168
+ */
169
+ interface Applicant {
170
+ /** Applicant's first name */
171
+ first_name: string;
172
+ /** Applicant's last name */
173
+ last_name: string;
174
+ /** Applicant's email address */
175
+ email: string;
176
+ /** Primary daytime / mobile phone number (required, 10 digits) */
177
+ phone_number: string;
178
+ /** Secondary / evening phone number (required, 10 digits) */
179
+ evening_phone_number: string;
180
+ /**
181
+ * Social Security Number — exactly 9 numeric digits, no dashes.
182
+ * @pattern ^\d{9}$
183
+ */
184
+ ssn: string;
185
+ /** Optional. If omitted, an fdr_applicant_id is generated by the server via the Applicant ID Service during registration. Omit this when the eligibility scout step (POST /v2/application/eligibility) is skipped. */
186
+ fdr_applicant_id?: string;
187
+ /** Seller-assigned applicant reference ID */
188
+ reference_id?: string;
189
+ /** Date the applicant gave user consent (ISO-8601 datetime) */
190
+ consent_date: string;
191
+ /** Applicant date of birth (YYYY-MM-DD, required) */
192
+ date_of_birth: string;
193
+ /** Spinwheel network user token for credit-pull linkage */
194
+ network_token: string;
195
+ physical_address: RegisterApplicantV2Address;
196
+ mailing_address?: RegisterApplicantV2Address;
197
+ }
198
+
199
+ /**
200
+ * Generated by orval v7.21.0 🍺
201
+ * Do not edit manually.
202
+ * ARPC — Achieve Resolution Partner Connect API
203
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
204
+ * OpenAPI spec version: 2026.15.0
205
+ */
206
+ interface ApplicationSendEmailResponse {
207
+ status?: string;
208
+ id?: string;
209
+ created_at?: string;
210
+ updated_at?: string;
211
+ }
212
+
213
+ /**
214
+ * Generated by orval v7.21.0 🍺
215
+ * Do not edit manually.
216
+ * ARPC — Achieve Resolution Partner Connect API
217
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
218
+ * OpenAPI spec version: 2026.15.0
219
+ */
220
+ /**
221
+ * Audit metadata
222
+ */
223
+ interface AuditInfo {
224
+ /** Date the user gave consent (ISO-8601) */
225
+ user_consent_date: string;
226
+ }
227
+
228
+ /**
229
+ * Generated by orval v7.21.0 🍺
230
+ * Do not edit manually.
231
+ * ARPC — Achieve Resolution Partner Connect API
232
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
233
+ * OpenAPI spec version: 2026.15.0
234
+ */
235
+
236
+ /**
237
+ * Bank account details used for programme drafts
238
+ * @nullable
239
+ */
240
+ type BankDetails = {
241
+ /** Bank name */
242
+ name?: string;
243
+ /** Account type */
244
+ account_type?: string;
245
+ /** Account sub-type */
246
+ account_subtype?: string;
247
+ /** Bank account number */
248
+ account_number?: string;
249
+ /** Bank routing number */
250
+ account_routing_number?: string;
251
+ /** Bank account validation status */
252
+ validation_status?: string;
253
+ /** Bank account validation message */
254
+ validation_message?: string;
255
+ /** Exact name on the bank account */
256
+ check_exact_name?: string;
257
+ check_exact_address?: Address;
258
+ /** Whether a pre-draft has been taken */
259
+ pre_draft?: boolean;
260
+ /** Bank verification code */
261
+ verification_code?: string;
262
+ /** Account holder mother's maiden name (security question) */
263
+ mother_maiden_name?: string;
264
+ /** Government-issued ID number for account verification */
265
+ government_issued_id?: string;
266
+ } | null;
267
+
268
+ /**
269
+ * Generated by orval v7.21.0 🍺
270
+ * Do not edit manually.
271
+ * ARPC — Achieve Resolution Partner Connect API
272
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
273
+ * OpenAPI spec version: 2026.15.0
274
+ */
275
+ /**
276
+ * Bank account input fields
277
+ */
278
+ interface BankDetailsInput {
279
+ /** Bank account number */
280
+ account_number: string;
281
+ /** Bank routing number (ABA) */
282
+ account_routing_number: string;
283
+ }
284
+
285
+ /**
286
+ * Generated by orval v7.21.0 🍺
287
+ * Do not edit manually.
288
+ * ARPC — Achieve Resolution Partner Connect API
289
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
290
+ * OpenAPI spec version: 2026.15.0
291
+ */
292
+
293
+ /**
294
+ * Request body to update applicant bank details after banking disclosure
295
+ */
296
+ interface BankUpdateRequest {
297
+ /** Whether the applicant has completed the banking disclosure step */
298
+ banking_disclosure_validation: boolean;
299
+ /** Bank verification code (micro-deposit or other challenge code) */
300
+ verification_code?: string;
301
+ bank_details: BankDetailsInput;
302
+ }
303
+
304
+ /**
305
+ * Generated by orval v7.21.0 🍺
306
+ * Do not edit manually.
307
+ * ARPC — Achieve Resolution Partner Connect API
308
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
309
+ * OpenAPI spec version: 2026.15.0
310
+ */
311
+ /**
312
+ * Check type identifier
313
+ */
314
+ type CheckType = typeof CheckType[keyof typeof CheckType];
315
+ declare const CheckType: {
316
+ readonly uw_submission: "uw_submission";
317
+ readonly dra: "dra";
318
+ };
319
+
320
+ /**
321
+ * Generated by orval v7.21.0 🍺
322
+ * Do not edit manually.
323
+ * ARPC — Achieve Resolution Partner Connect API
324
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
325
+ * OpenAPI spec version: 2026.15.0
326
+ */
327
+
328
+ /**
329
+ * Individual readiness check result
330
+ */
331
+ interface Check {
332
+ /** Check type identifier */
333
+ type?: CheckType;
334
+ /** Whether this check passed */
335
+ verified?: boolean;
336
+ /**
337
+ * Validation errors that caused this check to fail, if any
338
+ * @nullable
339
+ */
340
+ errors?: (string | null)[] | null;
341
+ }
342
+
343
+ /**
344
+ * Generated by orval v7.21.0 🍺
345
+ * Do not edit manually.
346
+ * ARPC — Achieve Resolution Partner Connect API
347
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
348
+ * OpenAPI spec version: 2026.15.0
349
+ */
350
+
351
+ /**
352
+ * Co-applicant details
353
+ */
354
+ interface CoApplicant {
355
+ /** FDR co-applicant identifier (auto-derived as applicant.id + '-c' if not supplied) */
356
+ fdr_applicant_id?: string;
357
+ /** First name */
358
+ first_name?: string;
359
+ /** Last name */
360
+ last_name?: string;
361
+ /** Social Security Number — 9 digits, no dashes */
362
+ social_security_number?: string;
363
+ /** Primary phone number */
364
+ phone_number?: string;
365
+ /** Email address */
366
+ email?: string;
367
+ /** Date of birth (YYYY-MM-DD) */
368
+ date_of_birth?: string;
369
+ current_address?: Address;
370
+ mailing_address?: Address;
371
+ /** Primary monthly income */
372
+ monthly_income?: number;
373
+ /** Other monthly income */
374
+ other_monthly_income?: number;
375
+ /** Monthly Social Security income */
376
+ social_security?: number;
377
+ /** Monthly retirement income */
378
+ retirement?: number;
379
+ /** Monthly dividend income */
380
+ dividends?: number;
381
+ /** Monthly annuity income */
382
+ annuities?: number;
383
+ /** Monthly other government assistance income */
384
+ other_government_assistance?: number;
385
+ /** Monthly child support income received */
386
+ child_support?: number;
387
+ /** Monthly alimony income received */
388
+ alimony?: number;
389
+ /** Monthly unemployment benefits */
390
+ unemployment?: number;
391
+ /** Monthly self-employment / 1099 income */
392
+ self_employment_1099_income?: number;
393
+ /** Next paycheck date (YYYY-MM-DD) */
394
+ next_pay_date?: string;
395
+ /** Pay frequency */
396
+ pay_frequency?: string;
397
+ /** Seller-assigned co-applicant reference ID */
398
+ reference_id?: string;
399
+ /** Credit pull source identifier */
400
+ credit_pull_source?: string;
401
+ /** Primary credit pull source */
402
+ primary_credit_pull_source?: string;
403
+ /** Secondary credit pull source */
404
+ secondary_credit_pull_source?: string;
405
+ /** Primary credit pull report ID for co-applicant */
406
+ cbr_primary_report_id?: string;
407
+ /** Secondary credit pull report ID for co-applicant */
408
+ cbr_secondary_report_id?: string;
409
+ }
410
+
411
+ /**
412
+ * Generated by orval v7.21.0 🍺
413
+ * Do not edit manually.
414
+ * ARPC — Achieve Resolution Partner Connect API
415
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
416
+ * OpenAPI spec version: 2026.15.0
417
+ */
418
+ /**
419
+ * Required consent strings for regulatory and platform compliance
420
+ */
421
+ interface Consents {
422
+ /** TCPA consent text */
423
+ tcpa?: string;
424
+ /** FCRA authorization text */
425
+ fcra?: string;
426
+ /** E-Sign consent text */
427
+ e_sign?: string;
428
+ /** Privacy policy acceptance text */
429
+ policy?: string;
430
+ /** Terms and conditions acceptance text */
431
+ term?: string;
432
+ }
433
+
434
+ /**
435
+ * Generated by orval v7.21.0 🍺
436
+ * Do not edit manually.
437
+ * ARPC — Achieve Resolution Partner Connect API
438
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
439
+ * OpenAPI spec version: 2026.15.0
440
+ */
441
+ /**
442
+ * Lead distribution routing configuration
443
+ */
444
+ interface LeadDistribution {
445
+ /** Name of the assigned lead owner */
446
+ owner_name?: string;
447
+ /** Whether to release the lead for distribution (defaults to false) */
448
+ lead_release_flag?: boolean;
449
+ }
450
+
451
+ /**
452
+ * Generated by orval v7.21.0 🍺
453
+ * Do not edit manually.
454
+ * ARPC — Achieve Resolution Partner Connect API
455
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
456
+ * OpenAPI spec version: 2026.15.0
457
+ */
458
+
459
+ /**
460
+ * Primary applicant details for lead creation (lead-shape field names)
461
+ */
462
+ interface LeadApplicantInput {
463
+ /** FDR applicant identifier alias (same value as fdr_applicant_id) */
464
+ id?: string;
465
+ /** FDR applicant identifier */
466
+ fdr_applicant_id?: string;
467
+ /** Credit Bureau Report ID */
468
+ cbr_report_id?: string;
469
+ /** Primary credit pull report ID */
470
+ cbr_primary_report_id?: string;
471
+ /** Secondary credit pull report ID */
472
+ cbr_secondary_report_id?: string;
473
+ /** First name */
474
+ first_name?: string;
475
+ /** Last name */
476
+ last_name?: string;
477
+ /** Social Security Number — 9 digits, no dashes */
478
+ social_security_number?: string;
479
+ /** Primary phone number */
480
+ phone_number?: string;
481
+ /** Evening phone number */
482
+ evening_phone_number?: string;
483
+ /** Mobile phone number */
484
+ mobile_phone_number?: string;
485
+ /** Email address */
486
+ email?: string;
487
+ /** Date of birth (YYYY-MM-DD) */
488
+ date_of_birth?: string;
489
+ current_address?: Address;
490
+ mailing_address?: Address;
491
+ /** Primary monthly income */
492
+ monthly_income?: number;
493
+ /** Other monthly income not captured in breakdown fields */
494
+ other_monthly_income?: number;
495
+ /** Description of other income sources */
496
+ other_income_description?: string;
497
+ /** Monthly Social Security income */
498
+ social_security?: number;
499
+ /** Monthly retirement income */
500
+ retirement?: number;
501
+ /** Monthly dividend income */
502
+ dividends?: number;
503
+ /** Monthly annuity income */
504
+ annuities?: number;
505
+ /** Monthly other government assistance income */
506
+ other_government_assistance?: number;
507
+ /** Monthly child support income received */
508
+ child_support?: number;
509
+ /** Monthly alimony income received */
510
+ alimony?: number;
511
+ /** Monthly unemployment benefits */
512
+ unemployment?: number;
513
+ /** Monthly self-employment / 1099 income */
514
+ self_employment_1099_income?: number;
515
+ /** Next paycheck date (YYYY-MM-DD) */
516
+ next_pay_date?: string;
517
+ /** Pay frequency */
518
+ pay_frequency?: string;
519
+ /** Seller-assigned applicant reference ID */
520
+ reference_id?: string;
521
+ /** Credit pull source identifier */
522
+ credit_pull_source?: string;
523
+ /** Primary credit pull source */
524
+ primary_credit_pull_source?: string;
525
+ /** Secondary credit pull source */
526
+ secondary_credit_pull_source?: string;
527
+ }
528
+
529
+ /**
530
+ * Generated by orval v7.21.0 🍺
531
+ * Do not edit manually.
532
+ * ARPC — Achieve Resolution Partner Connect API
533
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
534
+ * OpenAPI spec version: 2026.15.0
535
+ */
536
+ /**
537
+ * Whether the condition is currently active
538
+ */
539
+ type LeadConditionActive = typeof LeadConditionActive[keyof typeof LeadConditionActive];
540
+ declare const LeadConditionActive: {
541
+ readonly true: "true";
542
+ readonly false: "false";
543
+ };
544
+
545
+ /**
546
+ * Generated by orval v7.21.0 🍺
547
+ * Do not edit manually.
548
+ * ARPC — Achieve Resolution Partner Connect API
549
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
550
+ * OpenAPI spec version: 2026.15.0
551
+ */
552
+
553
+ /**
554
+ * Underwriting or program condition
555
+ * @nullable
556
+ */
557
+ type LeadCondition = {
558
+ /** Salesforce condition record ID */
559
+ id?: string;
560
+ /** Human-readable condition name */
561
+ name?: string;
562
+ /** Whether the condition is currently active */
563
+ active?: LeadConditionActive;
564
+ /** Condition type. soft-condition types omit the verified field in the response. */
565
+ type?: string;
566
+ /**
567
+ * Whether the condition has been verified by underwriting. Absent for soft-condition type.
568
+ * @nullable
569
+ */
570
+ verified?: boolean | null;
571
+ /** Internal condition template identifier */
572
+ condition_id?: string;
573
+ /** Applicant or seller response / documentation reference for this condition */
574
+ condition_response?: string;
575
+ /**
576
+ * Whether the condition was verified by a debt consultant
577
+ * @nullable
578
+ */
579
+ verified_by_debt_consultant?: boolean | null;
580
+ } | null;
581
+
582
+ /**
583
+ * Generated by orval v7.21.0 🍺
584
+ * Do not edit manually.
585
+ * ARPC — Achieve Resolution Partner Connect API
586
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
587
+ * OpenAPI spec version: 2026.15.0
588
+ */
589
+
590
+ /**
591
+ * Debt account to enroll in the program
592
+ */
593
+ interface DebtAccount {
594
+ /** Unique debt account identifier (from credit bureau pull) */
595
+ id?: string;
596
+ /** Source of the debt account record */
597
+ source?: string;
598
+ /** Credit report trade line ID linking to the bureau record */
599
+ credit_report_trade_line_id?: string;
600
+ /** Seller-assigned reference ID for this debt account */
601
+ reference_id?: string;
602
+ /** Seller system's internal ID for this debt account */
603
+ seller_debt_acct_id?: string;
604
+ /** Seller-defined optional metadata for this debt account */
605
+ seller_optional_debt_data?: string;
606
+ /** Account number at the creditor */
607
+ account_number?: string;
608
+ /** Condition of the account */
609
+ account_condition?: string;
610
+ /** Experian bureau flag or identifier for this account */
611
+ experian?: string;
612
+ /** Medical facility name (for medical debt accounts) */
613
+ medical_facility_name?: string;
614
+ /** Patient name (for medical debt accounts) */
615
+ patient_name?: string;
616
+ /** Current minimum monthly payment on this account */
617
+ current_monthly_payment?: number;
618
+ /** Original balance when the account was opened */
619
+ original_amount?: number;
620
+ /** Date the account was opened (YYYY-MM-DD) */
621
+ date_opened?: string;
622
+ /** Date the balance was last reported (YYYY-MM-DD) */
623
+ balance_date?: string;
624
+ /** Date of last payment made (YYYY-MM-DD) */
625
+ last_payment_date?: string;
626
+ /** Responsibility type for this account */
627
+ responsibility?: string;
628
+ /** Kind of business / creditor industry code */
629
+ kind_of_business?: string;
630
+ /** Type of credit account */
631
+ account_type?: string;
632
+ /** Account aging label (e.g. "Unknown", "Current", "30 Days") */
633
+ aging?: string;
634
+ /** Account repayment term length (months) */
635
+ terms?: number;
636
+ /** Underwriting conditions associated with this debt account */
637
+ conditions?: LeadCondition[];
638
+ /** Settlement priority rank for this account */
639
+ rank?: number;
640
+ /** Estimated time to settle (e.g. "1 - 3 Months", "10+ Months") */
641
+ months_to_settle?: string;
642
+ /** Whether this is a medical debt account */
643
+ is_medical_debt?: boolean;
644
+ /** Credit limit on the account */
645
+ credit_limit?: number;
646
+ /** Current creditor name */
647
+ creditor_name?: string;
648
+ /** Original creditor name */
649
+ original_creditor_name?: string;
650
+ /** Whether this debt belongs to the co-applicant */
651
+ co_applicant?: boolean;
652
+ /** Estimated current balance / debt amount */
653
+ estimated_debt?: number;
654
+ /** Enrollment status of this debt account */
655
+ status?: string;
656
+ /** Whether the debt account has been verified */
657
+ verified?: boolean;
658
+ }
659
+
660
+ /**
661
+ * Generated by orval v7.21.0 🍺
662
+ * Do not edit manually.
663
+ * ARPC — Achieve Resolution Partner Connect API
664
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
665
+ * OpenAPI spec version: 2026.15.0
666
+ */
667
+
668
+ /**
669
+ * Request body for creating a new DEX wholesale lead (POST /v3/application)
670
+ */
671
+ interface CreateLeadRequest {
672
+ /** External lead identifier, if pre-assigned */
673
+ id?: string;
674
+ /** Sales group routing identifier */
675
+ sales_group_id?: string;
676
+ /** FICO credit score of the primary applicant */
677
+ fico_score?: number;
678
+ /** Identifier of the originating lead platform */
679
+ lead_platform_id?: string;
680
+ /** Routing flag indicating FDR or CSS program path */
681
+ fdr_or_css?: string;
682
+ /** Source of the lead */
683
+ lead_source?: string;
684
+ /** Submission type of the lead */
685
+ lead_submission_type?: string;
686
+ /** Preferred communication language */
687
+ language?: string;
688
+ /** Email of the seller agent to be set as the Salesforce record owner */
689
+ seller_agent_email?: string;
690
+ /** Associated law firm identifier */
691
+ law_firm_id?: string;
692
+ /** Total debt amount stated by the applicant */
693
+ stated_debt_amount?: number;
694
+ /** Whether the applicant is behind on payments */
695
+ behind_payments?: boolean;
696
+ /** Seller net present value */
697
+ npv?: number;
698
+ /** Whether to pull a credit report during lead creation (defaults to false) */
699
+ pull_credit_report?: boolean;
700
+ /** Whether this is a merged credit pull (defaults to false) */
701
+ merged_pull?: boolean;
702
+ /** Credit Bureau Report ID for the co-applicant */
703
+ co_applicant_cbr_report_id?: string;
704
+ /** Credit pull source identifier (forwarded as credit_pull_source) */
705
+ credit_report_source?: string;
706
+ /** Credit bureau subscriber code */
707
+ subscriber_code?: string;
708
+ /** UTM campaign parameter */
709
+ utm_campaign?: string;
710
+ /** UTM content parameter */
711
+ utm_content?: string;
712
+ /** UTM medium parameter */
713
+ utm_medium?: string;
714
+ /** UTM term parameter */
715
+ utm_term?: string;
716
+ /** Seller-assigned lead reference ID */
717
+ reference_id?: string;
718
+ /** Seller applicant reference ID */
719
+ seller_applicant_ref_id?: string;
720
+ /** Optional seller data field 1 */
721
+ seller_optional_data_1?: string;
722
+ /** Optional seller data field 2 */
723
+ seller_optional_data_2?: string;
724
+ /** Business flow identifier field */
725
+ business_flow_field?: string;
726
+ /** Business flow ID */
727
+ business_flow_id?: string;
728
+ /** Lead transfer type */
729
+ transfer_type?: string;
730
+ /** Client Services state used to determine SMS eligibility */
731
+ cs_state_for_sms?: string;
732
+ /** Scheduled date and time for lead distribution (ISO-8601) */
733
+ scheduled_distribution_date_and_time?: string;
734
+ /** Unique distribution identifier */
735
+ distribution_identifier?: string;
736
+ lead_distribution?: LeadDistribution;
737
+ /** Monthly child care expenses */
738
+ child_care?: number;
739
+ /** Monthly other debt payment expenses */
740
+ other_debt_payments?: number;
741
+ /** Monthly out-of-pocket medical costs */
742
+ out_of_pocket_medical_costs?: number;
743
+ /** Monthly personal care, household, and miscellaneous expenses */
744
+ personal_care_house_hold_and_miscellaneous?: number;
745
+ /** Monthly utilities expenses */
746
+ utilities?: number;
747
+ /** Monthly non-deferred government student loan payments */
748
+ government_student_loans_non_deferred?: number;
749
+ /** Monthly non-deferred private student loan payments */
750
+ private_student_loans_non_deferred?: number;
751
+ /** Monthly legal and court-ordered expenses */
752
+ legal_and_court_ordered_expenses?: number;
753
+ /** Monthly food expenses */
754
+ food_expenses?: number;
755
+ /** Total medical debt amount */
756
+ medical_debt?: number;
757
+ /** Total business debt amount */
758
+ business_debt?: number;
759
+ /** Whether the applicant owns or rents their home */
760
+ own_or_rent?: string;
761
+ /** Monthly rent or mortgage payment */
762
+ rent_or_mortgage_monthly?: number;
763
+ /** Monthly transportation expenses */
764
+ transportation_expenses?: number;
765
+ /** Other miscellaneous monthly expenses (USD) */
766
+ other_expenses_describe?: number;
767
+ /** Primary hardship category code */
768
+ hardship_category?: string;
769
+ /** Free-text description when hardship category is 'other' */
770
+ hardship_category_other?: string;
771
+ /** Primary goal category code */
772
+ goal_category?: string;
773
+ /** Free-text description when goal category is 'other' */
774
+ goal_category_other?: string;
775
+ /** Next paycheck date (YYYY-MM-DD) */
776
+ next_pay_date?: string;
777
+ /** Pay frequency */
778
+ pay_frequency?: string;
779
+ /** Primary mobile phone number */
780
+ mobile_phone_number?: string;
781
+ /** Evening phone number */
782
+ evening_phone_number?: string;
783
+ /** Justification for housing expense amount */
784
+ housing_justification?: string;
785
+ /** Justification for transportation expense amount */
786
+ transportation_justification?: string;
787
+ /** Justification for food expense amount */
788
+ food_justification?: string;
789
+ /** Justification for income amount */
790
+ income_justification?: string;
791
+ /** Description of other debt-related expenses */
792
+ other_debt_expenses_description?: string;
793
+ /** Description of other miscellaneous expenses */
794
+ other_expenses_description?: string;
795
+ /** Free-text comments on income and expenses */
796
+ income_expenses_comments?: string;
797
+ applicant?: LeadApplicantInput;
798
+ co_applicant?: CoApplicant;
799
+ /**
800
+ * List of debt accounts to enroll in the program. Required only when the program response contains CBR-modified or DC-added trade lines (i.e. the program has adjusted or added accounts based on credit bureau data). Optional otherwise when pull_credit_report is true — debt accounts will be sourced from the credit report. When required, forward the debt_accounts array from the program response as-is; the server matches by 'id' and ignores unrecognised fields, so no transformation is needed.
801
+ * @nullable
802
+ */
803
+ debt_accounts?: DebtAccount[] | null;
804
+ }
805
+
806
+ /**
807
+ * Generated by orval v7.21.0 🍺
808
+ * Do not edit manually.
809
+ * ARPC — Achieve Resolution Partner Connect API
810
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
811
+ * OpenAPI spec version: 2026.15.0
812
+ */
813
+ /**
814
+ * Pay frequency
815
+ */
816
+ type LeadApplicantPayFrequency = typeof LeadApplicantPayFrequency[keyof typeof LeadApplicantPayFrequency];
817
+ declare const LeadApplicantPayFrequency: {
818
+ readonly weekly: "weekly";
819
+ readonly 'bi-weekly': "bi-weekly";
820
+ readonly 'semi-monthly': "semi-monthly";
821
+ readonly monthly: "monthly";
822
+ };
823
+
824
+ /**
825
+ * Generated by orval v7.21.0 🍺
826
+ * Do not edit manually.
827
+ * ARPC — Achieve Resolution Partner Connect API
828
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
829
+ * OpenAPI spec version: 2026.15.0
830
+ */
831
+ /**
832
+ * Current employment status
833
+ */
834
+ type LeadApplicantEmploymentStatus = typeof LeadApplicantEmploymentStatus[keyof typeof LeadApplicantEmploymentStatus];
835
+ declare const LeadApplicantEmploymentStatus: {
836
+ readonly 'Full-Time': "Full-Time";
837
+ readonly 'Part-Time': "Part-Time";
838
+ readonly 'Self-Employed': "Self-Employed";
839
+ readonly Unemployed: "Unemployed";
840
+ readonly Retired: "Retired";
841
+ readonly Other: "Other";
842
+ };
843
+
844
+ /**
845
+ * Generated by orval v7.21.0 🍺
846
+ * Do not edit manually.
847
+ * ARPC — Achieve Resolution Partner Connect API
848
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
849
+ * OpenAPI spec version: 2026.15.0
850
+ */
851
+
852
+ /**
853
+ * Applicant or co-applicant personal details
854
+ * @nullable
855
+ */
856
+ type LeadApplicant = {
857
+ /** Salesforce record ID — also echoes fdr_applicant_id value via JOLT mapping */
858
+ id?: string;
859
+ /** Applicant email address */
860
+ email?: string;
861
+ /** Monthly retirement income (USD) */
862
+ retirement?: number;
863
+ /** Monthly dividend income (USD) */
864
+ dividends?: number;
865
+ /** Monthly annuity income (USD) */
866
+ annuities?: number;
867
+ /** Monthly alimony income (USD) */
868
+ alimony?: number;
869
+ /** Monthly unemployment income (USD) */
870
+ unemployment?: number;
871
+ /** Bankruptcy status on file */
872
+ bankruptcy?: string;
873
+ /**
874
+ * Conditions associated with this applicant
875
+ * @nullable
876
+ */
877
+ conditions?: LeadCondition[] | null;
878
+ /** FDR applicant identifier */
879
+ fdr_applicant_id?: string;
880
+ /**
881
+ * Eligibility token generated during the eligibility check. Present in eligibility responses; null in other lead responses.
882
+ * @nullable
883
+ */
884
+ program_eligibility_token?: string | null;
885
+ /** Credit bureau report ID */
886
+ cbr_report_id?: string;
887
+ /** Applicant first name */
888
+ first_name?: string;
889
+ /** Applicant last name */
890
+ last_name?: string;
891
+ /** Middle name initial */
892
+ middle_name_initial?: string;
893
+ /** Primary phone number */
894
+ phone_number?: string;
895
+ /** Mobile phone number */
896
+ mobile_phone_number?: string;
897
+ /** Evening phone number */
898
+ evening_phone_number?: string;
899
+ /** Date of birth (YYYY-MM-DD) */
900
+ date_of_birth?: string;
901
+ /** Social Security Number (masked in logs) */
902
+ social_security_number?: string;
903
+ current_address?: Address;
904
+ mailing_address?: Address;
905
+ /** Applicant's gross monthly income (USD) */
906
+ monthly_income?: number;
907
+ /** Other monthly income sources (USD) */
908
+ other_monthly_income?: number;
909
+ /** True when this is the primary applicant on the account */
910
+ is_primary?: boolean;
911
+ /** True when the primary contact number is a mobile number */
912
+ is_mobile?: boolean;
913
+ /** Next scheduled pay date (YYYY-MM-DD) */
914
+ next_pay_date?: string;
915
+ /** Pay frequency */
916
+ pay_frequency?: LeadApplicantPayFrequency;
917
+ /** Seller-assigned reference ID for this applicant */
918
+ reference_id?: string;
919
+ /** Whether the applicant is program-eligible */
920
+ eligible?: boolean;
921
+ /** Monthly Social Security income (USD) */
922
+ social_security?: number;
923
+ /** Monthly other government assistance income (USD) */
924
+ other_government_assistance?: number;
925
+ /** Monthly child support income (USD) */
926
+ child_support?: number;
927
+ /** Monthly self-employment / 1099 income (USD) */
928
+ self_employment_1099_income?: number;
929
+ /** Description of other income sources */
930
+ other_income_description?: string;
931
+ /** Cerebro system applicant ID */
932
+ cerebro_id?: string;
933
+ /** Current employment status */
934
+ employment_status?: LeadApplicantEmploymentStatus;
935
+ /** Date of most recent paycheck (YYYY-MM-DD) */
936
+ last_pay_date?: string;
937
+ /** True when the applicant has opted out of email communications */
938
+ email_opt_out?: boolean;
939
+ /** Date of bankruptcy filing (YYYY-MM-DD) */
940
+ bankruptcy_date?: string;
941
+ } | null;
942
+
943
+ /**
944
+ * Generated by orval v7.21.0 🍺
945
+ * Do not edit manually.
946
+ * ARPC — Achieve Resolution Partner Connect API
947
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
948
+ * OpenAPI spec version: 2026.15.0
949
+ */
950
+ /**
951
+ * Indicates whether the program is FDR or CSS serviced
952
+ */
953
+ type LeadApplicationFdrOrCss = typeof LeadApplicationFdrOrCss[keyof typeof LeadApplicationFdrOrCss];
954
+ declare const LeadApplicationFdrOrCss: {
955
+ readonly FDR: "FDR";
956
+ readonly CSS: "CSS";
957
+ };
958
+
959
+ /**
960
+ * Generated by orval v7.21.0 🍺
961
+ * Do not edit manually.
962
+ * ARPC — Achieve Resolution Partner Connect API
963
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
964
+ * OpenAPI spec version: 2026.15.0
965
+ */
966
+ /**
967
+ * Whether client is on fixed income. Salesforce returns this as the string \"Yes\" or \"No\" (not a boolean).
968
+ */
969
+ type LeadApplicationFixedIncome = typeof LeadApplicationFixedIncome[keyof typeof LeadApplicationFixedIncome];
970
+ declare const LeadApplicationFixedIncome: {
971
+ readonly Yes: "Yes";
972
+ readonly No: "No";
973
+ };
974
+
975
+ /**
976
+ * Generated by orval v7.21.0 🍺
977
+ * Do not edit manually.
978
+ * ARPC — Achieve Resolution Partner Connect API
979
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
980
+ * OpenAPI spec version: 2026.15.0
981
+ */
982
+ /**
983
+ * Whether the client owns or rents their home
984
+ */
985
+ type LeadApplicationOwnOrRent = typeof LeadApplicationOwnOrRent[keyof typeof LeadApplicationOwnOrRent];
986
+ declare const LeadApplicationOwnOrRent: {
987
+ readonly Own: "Own";
988
+ readonly Rent: "Rent";
989
+ };
990
+
991
+ /**
992
+ * Generated by orval v7.21.0 🍺
993
+ * Do not edit manually.
994
+ * ARPC — Achieve Resolution Partner Connect API
995
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
996
+ * OpenAPI spec version: 2026.15.0
997
+ */
998
+ /**
999
+ * Source of the credit report pull (also present inside applicant)
1000
+ */
1001
+ type LeadApplicationCreditPullSource = typeof LeadApplicationCreditPullSource[keyof typeof LeadApplicationCreditPullSource];
1002
+ declare const LeadApplicationCreditPullSource: {
1003
+ readonly spinwheel: "spinwheel";
1004
+ readonly core: "core";
1005
+ };
1006
+
1007
+ /**
1008
+ * Generated by orval v7.21.0 🍺
1009
+ * Do not edit manually.
1010
+ * ARPC — Achieve Resolution Partner Connect API
1011
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
1012
+ * OpenAPI spec version: 2026.15.0
1013
+ */
1014
+ /**
1015
+ * Creditor or original creditor details
1016
+ */
1017
+ interface LeadCreditor {
1018
+ /** Salesforce creditor record ID */
1019
+ id?: string;
1020
+ /** Creditor display name */
1021
+ name?: string;
1022
+ /** Aggressive settlement indicator */
1023
+ aggressive?: string;
1024
+ /** Creditor type */
1025
+ type?: string;
1026
+ /** Creditor account status */
1027
+ status?: string;
1028
+ /** Alternative display name for the creditor (meta-creditor label) */
1029
+ other_name?: string;
1030
+ /** Meta-creditor identifier */
1031
+ meta_creditor_id?: string;
1032
+ /** Meta-creditor name */
1033
+ meta_creditor_name?: string;
1034
+ /** Client Services Salesforce ID for this creditor */
1035
+ cs_salesforce_id?: string;
1036
+ /** Credit bureau subscriber code */
1037
+ subscriber_code?: string;
1038
+ /** Expected settlement percentage for this creditor */
1039
+ settlement_percentage?: number;
1040
+ /** Kind-of-business code */
1041
+ kob?: string;
1042
+ }
1043
+
1044
+ /**
1045
+ * Generated by orval v7.21.0 🍺
1046
+ * Do not edit manually.
1047
+ * ARPC — Achieve Resolution Partner Connect API
1048
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
1049
+ * OpenAPI spec version: 2026.15.0
1050
+ */
1051
+ /**
1052
+ * Responsibility type for the account
1053
+ */
1054
+ type LeadDebtAccountResponsibility = typeof LeadDebtAccountResponsibility[keyof typeof LeadDebtAccountResponsibility];
1055
+ declare const LeadDebtAccountResponsibility: {
1056
+ readonly individual: "individual";
1057
+ readonly joint: "joint";
1058
+ readonly 'authorized-user': "authorized-user";
1059
+ };
1060
+
1061
+ /**
1062
+ * Generated by orval v7.21.0 🍺
1063
+ * Do not edit manually.
1064
+ * ARPC — Achieve Resolution Partner Connect API
1065
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
1066
+ * OpenAPI spec version: 2026.15.0
1067
+ */
1068
+ /**
1069
+ * Ownership of the account
1070
+ */
1071
+ type LeadDebtAccountOwnership = typeof LeadDebtAccountOwnership[keyof typeof LeadDebtAccountOwnership];
1072
+ declare const LeadDebtAccountOwnership: {
1073
+ readonly Applicant: "Applicant";
1074
+ readonly 'Co-Applicant': "Co-Applicant";
1075
+ readonly Joint: "Joint";
1076
+ };
1077
+
1078
+ /**
1079
+ * Generated by orval v7.21.0 🍺
1080
+ * Do not edit manually.
1081
+ * ARPC — Achieve Resolution Partner Connect API
1082
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
1083
+ * OpenAPI spec version: 2026.15.0
1084
+ */
1085
+ /**
1086
+ * Ineligibility reason code wrapper
1087
+ * @nullable
1088
+ */
1089
+ type IneligibleReason = {
1090
+ /** Ineligibility reason identifier */
1091
+ reason_id?: string;
1092
+ } | null;
1093
+
1094
+ /**
1095
+ * Generated by orval v7.21.0 🍺
1096
+ * Do not edit manually.
1097
+ * ARPC — Achieve Resolution Partner Connect API
1098
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
1099
+ * OpenAPI spec version: 2026.15.0
1100
+ */
1101
+
1102
+ /**
1103
+ * Debt account enrolled in or considered for the program
1104
+ */
1105
+ interface LeadDebtAccount {
1106
+ /** Salesforce debt account record ID */
1107
+ id?: string;
1108
+ /** Salesforce record name */
1109
+ name?: string;
1110
+ creditor?: LeadCreditor;
1111
+ /** Number of months in the account's term */
1112
+ terms?: number;
1113
+ /** Current status of the debt account */
1114
+ status?: string;
1115
+ /** Responsibility type for the account */
1116
+ responsibility?: LeadDebtAccountResponsibility;
1117
+ /** Ownership of the account */
1118
+ ownership?: LeadDebtAccountOwnership;
1119
+ /** Source of the debt account record */
1120
+ source?: string;
1121
+ /** Age / delinquency bucket of the debt */
1122
+ aging?: string;
1123
+ /** Rank assigned by DebtAccountRankingUtil (lower = higher priority) */
1124
+ rank?: number;
1125
+ /** Whether this debt account has been verified by underwriting. Converted from Salesforce Yes/No string to boolean. */
1126
+ verified?: boolean;
1127
+ /**
1128
+ * Conditions specific to this debt account
1129
+ * @nullable
1130
+ */
1131
+ conditions?: LeadCondition[] | null;
1132
+ /** External lead platform identifier for this account */
1133
+ lead_platform_id?: string;
1134
+ /** Credit bureau trade-line ID */
1135
+ credit_report_trade_line_id?: string;
1136
+ /** Display name of the current creditor (from meta-creditor other_name) */
1137
+ creditor_name?: string;
1138
+ /**
1139
+ * Alternative creditor name when creditor is not in the standard list
1140
+ * @nullable
1141
+ */
1142
+ current_creditor_other?: string | null;
1143
+ /** Display name of the original creditor. Falls back to original_creditor.name when other_name is absent. */
1144
+ original_creditor_name?: string;
1145
+ original_creditor?: LeadCreditor;
1146
+ /** Creditor account number */
1147
+ account_number?: string;
1148
+ /** Estimated balance owed (USD) */
1149
+ estimated_debt?: number;
1150
+ /** Original account balance at time of enrollment (USD) */
1151
+ original_amount?: number;
1152
+ /** Credit limit on the account (USD) */
1153
+ credit_limit?: number;
1154
+ /** Applicant's current monthly payment to this creditor (USD) */
1155
+ current_monthly_payment?: number;
1156
+ /** Whether the account is active */
1157
+ is_active?: string;
1158
+ /** Type of account */
1159
+ account_type?: string;
1160
+ /** Sub-type of the account */
1161
+ sub_account_type?: string;
1162
+ /** Condition of the account */
1163
+ account_condition?: string;
1164
+ /** Whether this is a secured account (Y/N string) */
1165
+ secured_account?: string;
1166
+ /** True when this is a secured account */
1167
+ is_secured?: boolean;
1168
+ /** True when this is a business debt account */
1169
+ is_business_debt?: boolean;
1170
+ /** Business debt account indicator (string) */
1171
+ business_debt_account?: string;
1172
+ /** True when this is a medical debt account */
1173
+ is_medical_debt?: boolean;
1174
+ /** True when this account is managed by a law firm */
1175
+ is_law_firm?: boolean;
1176
+ /** Credit bureau subscriber ID */
1177
+ subscriber_id?: string;
1178
+ /** Creditor kind-of-business code */
1179
+ kind_of_business?: string;
1180
+ /** Reason the account was marked inactive */
1181
+ inactive_reason?: string;
1182
+ /** Date account was opened (YYYY-MM-DD) */
1183
+ date_opened?: string;
1184
+ /** Date the balance was last reported (YYYY-MM-DD) */
1185
+ balance_date?: string;
1186
+ /** Date of the credit report pull (YYYY-MM-DD) */
1187
+ credit_report_date?: string;
1188
+ /** Date of last payment (YYYY-MM-DD) */
1189
+ last_payment_date?: string;
1190
+ /** Credit utilization percentage for this account (string) */
1191
+ credit_utilization?: string;
1192
+ /** Most recent delinquency bucket reported */
1193
+ most_recent_delinquency?: string;
1194
+ /** First name of the joint account holder, if applicable */
1195
+ joint_holder_first_name?: string;
1196
+ /** Last name of the joint account holder, if applicable */
1197
+ joint_holder_last_name?: string;
1198
+ /** Medical facility name for medical debt accounts */
1199
+ medical_facility_name?: string;
1200
+ /** Patient name for medical debt accounts */
1201
+ patient_name?: string;
1202
+ /** Estimated months until settlement */
1203
+ months_to_settle?: string;
1204
+ /** True when this debt account belongs to the co-applicant */
1205
+ co_applicant?: boolean;
1206
+ /**
1207
+ * Reasons this account is ineligible for the program, if any. Normalised from a comma-separated string to an array of reason objects.
1208
+ * @nullable
1209
+ */
1210
+ ineligible_reason?: IneligibleReason[] | null;
1211
+ }
1212
+
1213
+ /**
1214
+ * Generated by orval v7.21.0 🍺
1215
+ * Do not edit manually.
1216
+ * ARPC — Achieve Resolution Partner Connect API
1217
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
1218
+ * OpenAPI spec version: 2026.15.0
1219
+ */
1220
+ /**
1221
+ * A single selectable payment option
1222
+ * @nullable
1223
+ */
1224
+ type PaymentOption = {
1225
+ /** Monthly deposit amount for this option (USD) */
1226
+ monthly_deposit?: number;
1227
+ /** Total program cost for this option (USD) */
1228
+ program_cost?: number;
1229
+ /** Program length for this option (months) */
1230
+ program_length?: number;
1231
+ } | null;
1232
+
1233
+ /**
1234
+ * Generated by orval v7.21.0 🍺
1235
+ * Do not edit manually.
1236
+ * ARPC — Achieve Resolution Partner Connect API
1237
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
1238
+ * OpenAPI spec version: 2026.15.0
1239
+ */
1240
+
1241
+ /**
1242
+ * Managed Package program data after JOLT transformation
1243
+ */
1244
+ interface LeadApplication {
1245
+ /** Current program / opportunity stage */
1246
+ status?: string;
1247
+ /** Program lifecycle state (e.g. Active, Closed, Cancelled) */
1248
+ state?: string;
1249
+ /** Client's preferred language */
1250
+ language?: string;
1251
+ /**
1252
+ * Whether this application passed program eligibility checks
1253
+ * @nullable
1254
+ */
1255
+ eligible?: boolean | null;
1256
+ /** Program type / form type */
1257
+ type?: string;
1258
+ /** Responsibility level of the current owner (e.g. Debt Consultant, Underwriter) */
1259
+ responsibility?: string;
1260
+ /** Whether the program has been refreshed from Salesforce */
1261
+ refreshed?: boolean;
1262
+ /** Monthly utilities expenses (USD) */
1263
+ utilities?: number;
1264
+ applicant?: LeadApplicant;
1265
+ /**
1266
+ * Application-level underwriting conditions
1267
+ * @nullable
1268
+ */
1269
+ conditions?: LeadCondition[] | null;
1270
+ /** Sub-status of the current stage */
1271
+ sub_status?: string;
1272
+ /**
1273
+ * DEX-specific flow status set by the partner integration
1274
+ * @nullable
1275
+ */
1276
+ dex_flow_status?: string | null;
1277
+ /** Indicates whether the program is FDR or CSS serviced */
1278
+ fdr_or_css?: LeadApplicationFdrOrCss;
1279
+ /** Whether this application has a co-applicant */
1280
+ is_co_applicant?: boolean;
1281
+ /** Total estimated enrolled debt (USD) */
1282
+ estimated_total_debt?: number;
1283
+ /** Current monthly draft / deposit amount (USD) */
1284
+ monthly_deposit?: number;
1285
+ /** Estimated program length in months */
1286
+ estimated_program_length?: number;
1287
+ /** Estimated monthly program deposit (USD) */
1288
+ estimated_monthly_payment?: number;
1289
+ /** Estimated total settlement amount (USD) */
1290
+ estimated_settlement?: number;
1291
+ /** Estimated total savings compared to paying minimums (USD) */
1292
+ estimated_program_savings?: number;
1293
+ /** Estimated total program cost (USD) */
1294
+ estimated_program_cost?: number;
1295
+ /** Estimated total cost to the client over the program (USD) */
1296
+ estimated_cost_to_client?: number;
1297
+ /** Estimated program end date (YYYY-MM-DD) */
1298
+ estimated_program_end_date?: string;
1299
+ /** Estimated time to first settlement */
1300
+ estimated_time_to_first_settlement?: string;
1301
+ /** Estimated current total monthly minimum payments to all creditors (USD) */
1302
+ estimated_monthly_creditor_payment?: number;
1303
+ /** Minimum acceptable monthly deposit (USD) */
1304
+ minimum_monthly_payment?: number;
1305
+ /** Maximum acceptable monthly deposit (USD) */
1306
+ maximum_monthly_payment?: number;
1307
+ /** Minimum program length in months */
1308
+ minimum_program_length?: number;
1309
+ /** Maximum program length in months */
1310
+ maximum_program_length?: number;
1311
+ /** Minimum monthly payment based on enrolled debt calculation (USD) */
1312
+ estimated_debt_minimum_monthly_payment?: number;
1313
+ /** Maximum monthly payment based on enrolled debt calculation (USD) */
1314
+ estimated_debt_maximum_monthly_payment?: number;
1315
+ /** Minimum program length in months (debt-based) */
1316
+ estimated_program_minimum_length?: number;
1317
+ /** Maximum program length in months (debt-based) */
1318
+ estimated_program_maximum_length?: number;
1319
+ /** Program length for payment option 1 (months) */
1320
+ estimated_program_length_option_1?: number;
1321
+ /** Program length for payment option 2 (months) */
1322
+ estimated_program_length_option_2?: number;
1323
+ /** Program length for payment option 3 (months) */
1324
+ estimated_program_length_option_3?: number;
1325
+ /** Monthly deposit for payment option 1 (USD) */
1326
+ estimated_monthly_payment_option_1?: number;
1327
+ /** Monthly deposit for payment option 2 (USD) */
1328
+ estimated_monthly_payment_option_2?: number;
1329
+ /** Monthly deposit for payment option 3 (USD) */
1330
+ estimated_monthly_payment_option_3?: number;
1331
+ /** Total program cost for payment option 1 (USD) */
1332
+ estimated_cost_option_1?: number;
1333
+ /** Total program cost for payment option 2 (USD) */
1334
+ estimated_cost_option_2?: number;
1335
+ /** Total program cost for payment option 3 (USD) */
1336
+ estimated_cost_option_3?: number;
1337
+ /** Time to first settlement for option 1 */
1338
+ estimated_time_to_first_settlement_option_1?: string;
1339
+ /** Time to first settlement for option 2 */
1340
+ estimated_time_to_first_settlement_option_2?: string;
1341
+ /** Time to first settlement for option 3 */
1342
+ estimated_time_to_first_settlement_option_3?: string;
1343
+ /** FDR fee as a percentage of enrolled debt */
1344
+ fee_percentage?: number;
1345
+ /** Total FDR fee (USD) */
1346
+ fee_total?: number;
1347
+ /** FDR programme fee component (USD) */
1348
+ fdr_program_fee?: number;
1349
+ /** Bank service fee component (USD) */
1350
+ bank_service_fee?: number;
1351
+ /** Projected total cost if the applicant pays minimum payments only (USD) */
1352
+ do_nothing_total_cost?: number;
1353
+ /** Dollar savings vs. the do-nothing scenario (USD) */
1354
+ savings_off_do_nothing_cost?: number;
1355
+ /** Total interest/fee charges if paying minimums only (USD) */
1356
+ fee_charges_minimum_payments?: number;
1357
+ /** Fee savings compared to minimum payment path (USD) */
1358
+ fee_savings_vs_minimum_payments?: number;
1359
+ /** Months required to pay off debt via minimum payments */
1360
+ pay_down_time_minimum_payments?: number;
1361
+ /** Month savings vs. minimum payment path */
1362
+ program_time_savings_vs_minimum_payments?: number;
1363
+ /** Net savings vs. enrolled debt amount (USD) */
1364
+ savings_vs_enrolled_debt?: number;
1365
+ /** Monthly draft amount (USD) */
1366
+ draft_amount?: number;
1367
+ /** Draft frequency type */
1368
+ draft_type?: string;
1369
+ /** Date of first programme draft (YYYY-MM-DD) */
1370
+ first_draft_date?: string;
1371
+ /** Second draft date for bi-weekly drafts (YYYY-MM-DD) */
1372
+ second_draft_date_bi_weekly?: string;
1373
+ /** Programme start date (YYYY-MM-DD) */
1374
+ program_start_date?: string;
1375
+ /** Accounts past due 30 days (count string) */
1376
+ past_due_30_days?: string;
1377
+ /** Accounts past due 60 days (count string) */
1378
+ past_due_60_days?: string;
1379
+ /** Accounts past due 90 days (count string) */
1380
+ past_due_90_days?: string;
1381
+ /** Overall credit utilization across enrolled accounts */
1382
+ credit_utilization?: number;
1383
+ /** FICO credit score at time of enrollment */
1384
+ fico_score?: number;
1385
+ /** Combined household monthly income (USD) */
1386
+ combined_monthly_income?: number;
1387
+ /** Client's monthly disposable income after expenses (USD) */
1388
+ disposable_monthly_income?: number;
1389
+ /** Total monthly income (USD) */
1390
+ total_income_monthly?: number;
1391
+ /** Total monthly expenses (USD) */
1392
+ total_expenses_monthly?: number;
1393
+ /** Total estimated monthly expense (USD) */
1394
+ total_estimated_monthly_expense?: number;
1395
+ /** Total estimated monthly debt expenses (USD) */
1396
+ total_estimated_monthly_debt_expenses?: number;
1397
+ /** Whether client is on fixed income. Salesforce returns this as the string \"Yes\" or \"No\" (not a boolean). */
1398
+ fixed_income?: LeadApplicationFixedIncome;
1399
+ /** Monthly rent or mortgage expense (USD) */
1400
+ rent_or_mortgage_monthly?: number;
1401
+ /** Monthly transportation expenses (USD) */
1402
+ transportation_expenses?: number;
1403
+ /** Monthly food expenses (USD) */
1404
+ food_expenses?: number;
1405
+ /** Monthly child care expenses (USD) */
1406
+ child_care?: number;
1407
+ /** Monthly out-of-pocket medical costs (USD) */
1408
+ out_of_pocket_medical_costs?: number;
1409
+ /** Monthly personal care, household, and miscellaneous expenses (USD) */
1410
+ personal_care_house_hold_and_miscellaneous?: number;
1411
+ /** Monthly legal and court-ordered expenses (USD) */
1412
+ legal_and_court_ordered_expenses?: number;
1413
+ /** Monthly government student loan payments, non-deferred (USD) */
1414
+ government_student_loans_non_deferred?: number;
1415
+ /** Monthly private student loan payments, non-deferred (USD) */
1416
+ private_student_loans_non_deferred?: number;
1417
+ /** Monthly other debt payments (USD) */
1418
+ other_debt_payments?: number;
1419
+ /** Whether the client owns or rents their home */
1420
+ own_or_rent?: LeadApplicationOwnOrRent;
1421
+ /** Total medical debt amount in program (USD) */
1422
+ medical_debt?: number;
1423
+ /** Total business debt amount in program (USD) */
1424
+ business_debt?: number;
1425
+ /** Total debt consolidation amount (USD) */
1426
+ debt_consolidation?: number;
1427
+ /** Total credit counseling debt amount (USD) */
1428
+ credit_counseling?: number;
1429
+ /** Other expenses amount (numeric) */
1430
+ other_expenses_describe?: number;
1431
+ /** Primary hardship category */
1432
+ hardship_category?: string;
1433
+ /**
1434
+ * Free-text hardship description when category is 'Other'
1435
+ * @nullable
1436
+ */
1437
+ hardship_category_other?: string | null;
1438
+ /** Client's primary financial goal category */
1439
+ goal_category?: string;
1440
+ /**
1441
+ * Free-text goal when category is 'Other'
1442
+ * @nullable
1443
+ */
1444
+ goal_category_other?: string | null;
1445
+ /** Client's secondary financial goal */
1446
+ secondary_goal?: string;
1447
+ /** Justification for housing cost amount */
1448
+ housing_justification?: string;
1449
+ /** Justification for transportation cost amount */
1450
+ transportation_justification?: string;
1451
+ /** Justification for food cost amount */
1452
+ food_justification?: string;
1453
+ /** Description of other debt expense amounts */
1454
+ other_debt_expenses_description?: string;
1455
+ /** Description of other expense amounts */
1456
+ other_expenses_description?: string;
1457
+ /** Description of other income sources */
1458
+ other_income_description?: string;
1459
+ /** General comments on income and expenses */
1460
+ income_expenses_comments?: string;
1461
+ /** Grounds for exception when cash flow is negative */
1462
+ negative_cash_flow_grounds_for_exception?: string;
1463
+ /** Justification for net income amount */
1464
+ income_justification?: string;
1465
+ /**
1466
+ * Assigned law firm identifier
1467
+ * @nullable
1468
+ */
1469
+ law_firm_id?: string | null;
1470
+ /** Salesforce record creation timestamp */
1471
+ created_date?: string;
1472
+ /** Salesforce record close date (YYYY-MM-DD) */
1473
+ closed_date?: string;
1474
+ /** Date and time the lead was released to distribution */
1475
+ release_date_and_time?: string;
1476
+ /** Salesforce account record ID */
1477
+ account_id?: string;
1478
+ /** Salesforce lead record ID (00Q prefix) */
1479
+ lead_id?: string;
1480
+ /** Self-reported total debt amount before enrollment (USD) */
1481
+ stated_debt_amount?: number;
1482
+ /** Total debt enrolled in the program (USD) */
1483
+ total_enrolled_debt?: number;
1484
+ /** Whether the program summary call has been completed */
1485
+ program_summary_call_completed?: boolean;
1486
+ /** Code used to verify the prospect */
1487
+ prospect_verification_code?: string;
1488
+ /** Business flow identifier */
1489
+ business_flow_field?: string;
1490
+ /** Whether the program was force-enrolled into Plus */
1491
+ forced_plus?: boolean;
1492
+ /** Whether this record was merged from a pull */
1493
+ merged_pull?: boolean;
1494
+ /** Whether a terms exception has been granted */
1495
+ terms_exception?: boolean;
1496
+ /** Net present value of the program */
1497
+ npv?: number;
1498
+ /** Predicted likelihood of draft failure (0–1) */
1499
+ likelihood_of_draft_failure?: number;
1500
+ /** Whether the client has opted out of SMS communications */
1501
+ sms_opt_out?: boolean;
1502
+ /** Client persona segment */
1503
+ persona?: string;
1504
+ /** Lead origination source */
1505
+ lead_source?: string;
1506
+ /** Type of lead submission */
1507
+ lead_submission_type?: string;
1508
+ /** Partner distribution identifier */
1509
+ distribution_identifier?: string;
1510
+ /** Distribution domain of the originating partner */
1511
+ distribution_domain?: string;
1512
+ /** Distribution type */
1513
+ distribution_type?: string;
1514
+ /** Distribution event that triggered this lead */
1515
+ distribution_event?: string;
1516
+ /** Intended agent group for routing */
1517
+ intended_agent_group?: string;
1518
+ /** Agent skill required for this lead */
1519
+ agent_skill?: string;
1520
+ /** Predictive lead score */
1521
+ lead_score?: number;
1522
+ /** Timestamp when the lead score was last calculated */
1523
+ lead_score_date_time?: string;
1524
+ /** Seller-assigned reference / opportunity ID */
1525
+ reference_id?: string;
1526
+ /** Email of the seller agent who owns the lead */
1527
+ seller_agent_email?: string;
1528
+ /** Source of the credit report pull (also present inside applicant) */
1529
+ credit_pull_source?: LeadApplicationCreditPullSource;
1530
+ /** Date of credit report pull (YYYY-MM-DD) */
1531
+ credit_pull_date?: string;
1532
+ /** Whether the consent disclosure has been checked */
1533
+ consent_checked?: boolean;
1534
+ /** Whether IDQ (Identity Quality) check has been completed */
1535
+ idq_checked?: boolean;
1536
+ /**
1537
+ * Primary applicant credit bureau report ID, also present inside applicant.cbr_report_id
1538
+ * @nullable
1539
+ */
1540
+ cbr_report_id?: string | null;
1541
+ /**
1542
+ * Co-applicant credit bureau report ID (JOLT special mapping)
1543
+ * @nullable
1544
+ */
1545
+ co_applicant_cbr_report_id?: string | null;
1546
+ co_applicant?: LeadApplicant;
1547
+ /** Debt accounts associated with this application */
1548
+ debt_accounts?: LeadDebtAccount[];
1549
+ /**
1550
+ * Selectable payment options (3 tiers)
1551
+ * @nullable
1552
+ */
1553
+ payment_options?: PaymentOption[] | null;
1554
+ bank_details?: BankDetails;
1555
+ /**
1556
+ * Reasons the application is ineligible, if any. Normalised from a comma-separated string to an array of reason objects.
1557
+ * @nullable
1558
+ */
1559
+ ineligible_reason?: IneligibleReason[] | null;
1560
+ }
1561
+
1562
+ /**
1563
+ * Generated by orval v7.21.0 🍺
1564
+ * Do not edit manually.
1565
+ * ARPC — Achieve Resolution Partner Connect API
1566
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
1567
+ * OpenAPI spec version: 2026.15.0
1568
+ */
1569
+
1570
+ /**
1571
+ * Response returned after successfully creating a DEX lead
1572
+ */
1573
+ interface CreateLeadResponse {
1574
+ /** Correlation / tracking identifier (x-correlation-id echo) */
1575
+ id?: string;
1576
+ /** FDR applicant identifier */
1577
+ fdr_applicant_id?: string;
1578
+ /** Human-readable result message */
1579
+ message?: string;
1580
+ application?: LeadApplication;
1581
+ }
1582
+
1583
+ /**
1584
+ * Generated by orval v7.21.0 🍺
1585
+ * Do not edit manually.
1586
+ * ARPC — Achieve Resolution Partner Connect API
1587
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
1588
+ * OpenAPI spec version: 2026.15.0
1589
+ */
1590
+ /**
1591
+ * Consent record for soft credit pull
1592
+ * @nullable
1593
+ */
1594
+ type CreditPullConsent = {
1595
+ /** ISO-8601 datetime when consent was obtained (must start with YYYY-MM-DD) */
1596
+ date_time: string;
1597
+ } | null;
1598
+
1599
+ /**
1600
+ * Generated by orval v7.21.0 🍺
1601
+ * Do not edit manually.
1602
+ * ARPC — Achieve Resolution Partner Connect API
1603
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
1604
+ * OpenAPI spec version: 2026.15.0
1605
+ */
1606
+ /**
1607
+ * Applicant signing URL details
1608
+ */
1609
+ interface DraApplicant {
1610
+ /** Embedded DocuSign signing URL. Redirect the applicant to this URL to complete signing. */
1611
+ url?: string;
1612
+ }
1613
+
1614
+ /**
1615
+ * Generated by orval v7.21.0 🍺
1616
+ * Do not edit manually.
1617
+ * ARPC — Achieve Resolution Partner Connect API
1618
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
1619
+ * OpenAPI spec version: 2026.15.0
1620
+ */
1621
+ /**
1622
+ * DocuSign signing method. Use 'url' for embedded signing, 'email' for standard email signing.
1623
+ */
1624
+ type DraApplicantInputSigningType = typeof DraApplicantInputSigningType[keyof typeof DraApplicantInputSigningType];
1625
+ declare const DraApplicantInputSigningType: {
1626
+ readonly url: "url";
1627
+ readonly email: "email";
1628
+ };
1629
+
1630
+ /**
1631
+ * Generated by orval v7.21.0 🍺
1632
+ * Do not edit manually.
1633
+ * ARPC — Achieve Resolution Partner Connect API
1634
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
1635
+ * OpenAPI spec version: 2026.15.0
1636
+ */
1637
+
1638
+ /**
1639
+ * Applicant DRA signing preferences
1640
+ */
1641
+ interface DraApplicantInput {
1642
+ /** DocuSign signing method. Use 'url' for embedded signing, 'email' for standard email signing. */
1643
+ signing_type?: DraApplicantInputSigningType;
1644
+ }
1645
+
1646
+ /**
1647
+ * Generated by orval v7.21.0 🍺
1648
+ * Do not edit manually.
1649
+ * ARPC — Achieve Resolution Partner Connect API
1650
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
1651
+ * OpenAPI spec version: 2026.15.0
1652
+ */
1653
+
1654
+ /**
1655
+ * Request body to generate a Debt Resolution Agreement (DRA) signing session
1656
+ */
1657
+ interface DraRequest {
1658
+ /** URL to redirect the applicant to after completing or declining the DocuSign session */
1659
+ returning_url?: string;
1660
+ applicant?: DraApplicantInput;
1661
+ }
1662
+
1663
+ /**
1664
+ * Generated by orval v7.21.0 🍺
1665
+ * Do not edit manually.
1666
+ * ARPC — Achieve Resolution Partner Connect API
1667
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
1668
+ * OpenAPI spec version: 2026.15.0
1669
+ */
1670
+
1671
+ /**
1672
+ * Response containing the DocuSign envelope ID and embedded signing URL
1673
+ */
1674
+ interface DraResponse {
1675
+ applicant?: DraApplicant;
1676
+ /** DocuSign envelope ID for this signing session */
1677
+ envelopeId?: string;
1678
+ }
1679
+
1680
+ /**
1681
+ * Generated by orval v7.21.0 🍺
1682
+ * Do not edit manually.
1683
+ * ARPC — Achieve Resolution Partner Connect API
1684
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
1685
+ * OpenAPI spec version: 2026.15.0
1686
+ */
1687
+ /**
1688
+ * Address for eligibility request
1689
+ */
1690
+ interface EligibilityAddress {
1691
+ /** Two-letter US state code */
1692
+ state: string;
1693
+ /** Street address line 1 */
1694
+ line1?: string;
1695
+ /** City */
1696
+ city?: string;
1697
+ /** ZIP code */
1698
+ zip_code?: string;
1699
+ /** ISO country code */
1700
+ country?: string;
1701
+ }
1702
+
1703
+ /**
1704
+ * Generated by orval v7.21.0 🍺
1705
+ * Do not edit manually.
1706
+ * ARPC — Achieve Resolution Partner Connect API
1707
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
1708
+ * OpenAPI spec version: 2026.15.0
1709
+ */
1710
+
1711
+ /**
1712
+ * Applicant fields for eligibility. Full PII required only when pull_credit_report is true.
1713
+ */
1714
+ interface EligibilityApplicant {
1715
+ /** Applicant first name */
1716
+ first_name?: string;
1717
+ /** Applicant last name */
1718
+ last_name?: string;
1719
+ /** Primary phone number */
1720
+ phone_number?: string;
1721
+ /** Evening / alternate phone number */
1722
+ evening_phone_number?: string;
1723
+ /** Date of birth (YYYY-MM-DD) */
1724
+ date_of_birth?: string;
1725
+ current_address?: EligibilityAddress;
1726
+ mailing_address?: EligibilityAddress;
1727
+ credit_pull_consent?: CreditPullConsent;
1728
+ }
1729
+
1730
+ /**
1731
+ * Generated by orval v7.21.0 🍺
1732
+ * Do not edit manually.
1733
+ * ARPC — Achieve Resolution Partner Connect API
1734
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
1735
+ * OpenAPI spec version: 2026.15.0
1736
+ */
1737
+
1738
+ /**
1739
+ * Program data returned by the eligibility endpoint. A focused subset of the full lead application object.
1740
+ */
1741
+ interface EligibilityApplication {
1742
+ applicant?: LeadApplicant;
1743
+ /** Debt accounts used in the eligibility calculation */
1744
+ debt_accounts?: LeadDebtAccount[];
1745
+ /** Selectable payment options (3 tiers) */
1746
+ payment_options?: PaymentOption[];
1747
+ /** Total enrolled debt (USD) */
1748
+ estimated_total_debt?: number;
1749
+ /** Total cost if no action taken (USD) */
1750
+ do_nothing_total_cost?: number;
1751
+ /** Recommended monthly deposit (USD) */
1752
+ monthly_deposit?: number;
1753
+ /** Recommended program length in months */
1754
+ estimated_program_length?: number;
1755
+ /** Recommended monthly payment (USD) */
1756
+ estimated_monthly_payment?: number;
1757
+ /** Total program cost (USD) */
1758
+ estimated_program_cost?: number;
1759
+ /** Total cost to client (USD) */
1760
+ estimated_cost_to_client?: number;
1761
+ /** Total savings compared to do-nothing path (USD) */
1762
+ estimated_program_savings?: number;
1763
+ /** Estimated settlement percentage */
1764
+ estimated_settlement?: number;
1765
+ /** Estimated time to first settlement */
1766
+ estimated_time_to_first_settlement?: string;
1767
+ /** Current estimated monthly creditor payment (USD) */
1768
+ estimated_monthly_creditor_payment?: number;
1769
+ /** Program length for option 1 (months) */
1770
+ estimated_program_length_option_1?: number;
1771
+ /** Program length for option 2 (months) */
1772
+ estimated_program_length_option_2?: number;
1773
+ /** Program length for option 3 (months) */
1774
+ estimated_program_length_option_3?: number;
1775
+ /** Monthly payment for option 1 (USD) */
1776
+ estimated_monthly_payment_option_1?: number;
1777
+ /** Monthly payment for option 2 (USD) */
1778
+ estimated_monthly_payment_option_2?: number;
1779
+ /** Monthly payment for option 3 (USD) */
1780
+ estimated_monthly_payment_option_3?: number;
1781
+ /** Total cost for option 1 (USD) */
1782
+ estimated_cost_option_1?: number;
1783
+ /** Total cost for option 2 (USD) */
1784
+ estimated_cost_option_2?: number;
1785
+ /** Total cost for option 3 (USD) */
1786
+ estimated_cost_option_3?: number;
1787
+ /** Time to first settlement for option 1 */
1788
+ estimated_time_to_first_settlement_option_1?: string;
1789
+ /** Time to first settlement for option 2 */
1790
+ estimated_time_to_first_settlement_option_2?: string;
1791
+ /** Time to first settlement for option 3 */
1792
+ estimated_time_to_first_settlement_option_3?: string;
1793
+ /** Service fee percentage */
1794
+ fee_percentage?: number;
1795
+ /** Total service fee (USD) */
1796
+ fee_total?: number;
1797
+ /** Fee charges on minimum payment path (USD) */
1798
+ fee_charges_minimum_payments?: number;
1799
+ /** Fee savings compared to minimum payment path (USD) */
1800
+ fee_savings_vs_min_payments?: number;
1801
+ /** Savings vs. do-nothing total cost (USD) */
1802
+ savings_off_do_nothing_cost?: number;
1803
+ /** Months to pay off on minimum payment path */
1804
+ pay_down_time_minimum_payments?: number;
1805
+ /** Months saved vs. minimum payment path */
1806
+ program_time_savings_vs_minimum_payments?: number;
1807
+ }
1808
+
1809
+ /**
1810
+ * Generated by orval v7.21.0 🍺
1811
+ * Do not edit manually.
1812
+ * ARPC — Achieve Resolution Partner Connect API
1813
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
1814
+ * OpenAPI spec version: 2026.15.0
1815
+ */
1816
+ /**
1817
+ * Debt account entry for eligibility check (no-credit-pull path)
1818
+ * @nullable
1819
+ */
1820
+ type EligibilityDebtAccount = {
1821
+ /** Origin of this debt account record */
1822
+ source?: string;
1823
+ /** Seller-assigned reference ID */
1824
+ reference_id?: string;
1825
+ /** Date the account was opened (YYYY-MM-DD) */
1826
+ open_date?: string;
1827
+ /** Estimated outstanding balance */
1828
+ estimated_debt?: number;
1829
+ /** Current minimum monthly payment */
1830
+ current_monthly_payment?: number;
1831
+ /**
1832
+ * Alternative creditor name when creditor is not in the standard list
1833
+ * @nullable
1834
+ */
1835
+ current_creditor_other?: string | null;
1836
+ /** Creditor name */
1837
+ creditor_name?: string;
1838
+ /** Account type */
1839
+ account_type?: string;
1840
+ /** Last 4 digits or masked account number */
1841
+ account_number?: string;
1842
+ /**
1843
+ * Condition of the account
1844
+ * @nullable
1845
+ */
1846
+ account_condition?: string | null;
1847
+ } | null;
1848
+
1849
+ /**
1850
+ * Generated by orval v7.21.0 🍺
1851
+ * Do not edit manually.
1852
+ * ARPC — Achieve Resolution Partner Connect API
1853
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
1854
+ * OpenAPI spec version: 2026.15.0
1855
+ */
1856
+
1857
+ /**
1858
+ * Request body for the eligibility check. Applicant PII is only required when pull_credit_report is true.
1859
+ */
1860
+ interface EligibilityRequest {
1861
+ /** Whether to pull a live soft credit report. When false, debt_accounts must be provided instead. */
1862
+ pull_credit_report: boolean;
1863
+ applicant?: EligibilityApplicant;
1864
+ /**
1865
+ * Debt accounts to evaluate. Required when pull_credit_report is false.
1866
+ * @nullable
1867
+ */
1868
+ debt_accounts?: EligibilityDebtAccount[] | null;
1869
+ }
1870
+
1871
+ /**
1872
+ * Generated by orval v7.21.0 🍺
1873
+ * Do not edit manually.
1874
+ * ARPC — Achieve Resolution Partner Connect API
1875
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
1876
+ * OpenAPI spec version: 2026.15.0
1877
+ */
1878
+
1879
+ /**
1880
+ * Response from POST /v2/application/eligibility
1881
+ */
1882
+ interface EligibilityResponse {
1883
+ /** Request correlation / tracking identifier (echoes x-correlation-id header) */
1884
+ id?: string;
1885
+ /** Result message */
1886
+ message?: string;
1887
+ application?: EligibilityApplication;
1888
+ }
1889
+
1890
+ /**
1891
+ * Generated by orval v7.21.0 🍺
1892
+ * Do not edit manually.
1893
+ * ARPC — Achieve Resolution Partner Connect API
1894
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
1895
+ * OpenAPI spec version: 2026.15.0
1896
+ */
1897
+ /**
1898
+ * Gate type identifier
1899
+ */
1900
+ type ReadinessCheckType = typeof ReadinessCheckType[keyof typeof ReadinessCheckType];
1901
+ declare const ReadinessCheckType: {
1902
+ readonly uw_submission: "uw_submission";
1903
+ readonly dra: "dra";
1904
+ };
1905
+
1906
+ /**
1907
+ * Generated by orval v7.21.0 🍺
1908
+ * Do not edit manually.
1909
+ * ARPC — Achieve Resolution Partner Connect API
1910
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
1911
+ * OpenAPI spec version: 2026.15.0
1912
+ */
1913
+
1914
+ /**
1915
+ * Result of a single readiness gate check
1916
+ */
1917
+ interface ReadinessCheck {
1918
+ /** Gate type identifier */
1919
+ type?: ReadinessCheckType;
1920
+ /** Whether this gate passed */
1921
+ verified?: boolean;
1922
+ /** Validation errors for this gate, if any */
1923
+ errors?: string[];
1924
+ }
1925
+
1926
+ /**
1927
+ * Generated by orval v7.21.0 🍺
1928
+ * Do not edit manually.
1929
+ * ARPC — Achieve Resolution Partner Connect API
1930
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
1931
+ * OpenAPI spec version: 2026.15.0
1932
+ */
1933
+
1934
+ /**
1935
+ * Readiness check breakdown
1936
+ */
1937
+ interface ErrorDetails {
1938
+ /** Per-gate check results */
1939
+ checks?: ReadinessCheck[];
1940
+ /** Whether a program refresh is required before re-submission */
1941
+ is_program_refresh_required?: boolean;
1942
+ /** Whether the application is currently UW-approved */
1943
+ is_uw_approved?: boolean;
1944
+ }
1945
+
1946
+ /**
1947
+ * Generated by orval v7.21.0 🍺
1948
+ * Do not edit manually.
1949
+ * ARPC — Achieve Resolution Partner Connect API
1950
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
1951
+ * OpenAPI spec version: 2026.15.0
1952
+ */
1953
+ /**
1954
+ * Address — used for current and mailing address updates
1955
+ */
1956
+ interface PatchAddress {
1957
+ /** Street address line 1 */
1958
+ line1?: string;
1959
+ /** City */
1960
+ city?: string;
1961
+ /** US state code (2 characters) */
1962
+ state?: string;
1963
+ /** 5-digit ZIP code */
1964
+ zip_code?: string;
1965
+ /** Country code */
1966
+ country?: string;
1967
+ }
1968
+
1969
+ /**
1970
+ * Generated by orval v7.21.0 🍺
1971
+ * Do not edit manually.
1972
+ * ARPC — Achieve Resolution Partner Connect API
1973
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
1974
+ * OpenAPI spec version: 2026.15.0
1975
+ */
1976
+
1977
+ /**
1978
+ * Applicant fields that can be patched
1979
+ */
1980
+ interface PatchApplicant {
1981
+ /** First name */
1982
+ first_name?: string;
1983
+ /** Last name */
1984
+ last_name?: string;
1985
+ /** Social Security Number — 9 digits, no dashes */
1986
+ social_security_number?: string;
1987
+ /** Date of birth (YYYY-MM-DD) */
1988
+ date_of_birth?: string;
1989
+ /** Primary phone number */
1990
+ phone_number?: string;
1991
+ /** Evening phone number */
1992
+ evening_phone_number?: string;
1993
+ /** Mobile phone number */
1994
+ mobile_phone_number?: string;
1995
+ /** Applicant email address */
1996
+ email?: string;
1997
+ current_address?: PatchAddress;
1998
+ mailing_address?: PatchAddress;
1999
+ /** FDR applicant identifier */
2000
+ fdr_applicant_id?: string;
2001
+ /** Credit Bureau Report ID */
2002
+ cbr_report_id?: string;
2003
+ /** Whether the applicant has filed for bankruptcy */
2004
+ bankruptcy?: boolean;
2005
+ /** Date of bankruptcy filing (YYYY-MM-DD) */
2006
+ bankruptcy_date?: string;
2007
+ /** Employment status */
2008
+ employment_status?: string;
2009
+ /** Primary monthly income */
2010
+ monthly_income?: number;
2011
+ /** Other monthly income */
2012
+ other_monthly_income?: number;
2013
+ /** Description of other income sources */
2014
+ other_income_description?: string;
2015
+ /** Monthly Social Security income */
2016
+ social_security?: number;
2017
+ /** Monthly retirement income */
2018
+ retirement?: number;
2019
+ /** Monthly dividend income */
2020
+ dividends?: number;
2021
+ /** Monthly annuity income */
2022
+ annuities?: number;
2023
+ /** Monthly other government assistance income */
2024
+ other_government_assistance?: number;
2025
+ /** Monthly child support income received */
2026
+ child_support?: number;
2027
+ /** Monthly alimony income received */
2028
+ alimony?: number;
2029
+ /** Monthly unemployment benefits */
2030
+ unemployment?: number;
2031
+ /** Monthly self-employment / 1099 income */
2032
+ self_employment_1099_income?: number;
2033
+ /** Next pay date (YYYY-MM-DD) */
2034
+ next_pay_date?: string;
2035
+ /** Pay frequency */
2036
+ pay_frequency?: string;
2037
+ }
2038
+
2039
+ /**
2040
+ * Generated by orval v7.21.0 🍺
2041
+ * Do not edit manually.
2042
+ * ARPC — Achieve Resolution Partner Connect API
2043
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
2044
+ * OpenAPI spec version: 2026.15.0
2045
+ */
2046
+ /**
2047
+ * Condition to verify (lead-level or debt-account-level)
2048
+ */
2049
+ interface PatchCondition {
2050
+ /** Salesforce condition record ID */
2051
+ id?: string;
2052
+ /** Whether the condition has been verified by the debt consultant */
2053
+ verified_by_debt_consultant?: boolean;
2054
+ /** Whether this entry is a condition response */
2055
+ is_condition_response?: boolean;
2056
+ }
2057
+
2058
+ /**
2059
+ * Generated by orval v7.21.0 🍺
2060
+ * Do not edit manually.
2061
+ * ARPC — Achieve Resolution Partner Connect API
2062
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
2063
+ * OpenAPI spec version: 2026.15.0
2064
+ */
2065
+
2066
+ /**
2067
+ * Debt account patch entry — id is required to route the update; only provided fields are changed
2068
+ */
2069
+ interface PatchDebtAccount {
2070
+ /** Salesforce debt account record ID (required) */
2071
+ id?: string;
2072
+ /** Debt account status */
2073
+ status?: string;
2074
+ /** Debt account source */
2075
+ source?: string;
2076
+ /** Conditions to verify on this debt account */
2077
+ conditions?: PatchCondition[];
2078
+ }
2079
+
2080
+ /**
2081
+ * Generated by orval v7.21.0 🍺
2082
+ * Do not edit manually.
2083
+ * ARPC — Achieve Resolution Partner Connect API
2084
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
2085
+ * OpenAPI spec version: 2026.15.0
2086
+ */
2087
+ /**
2088
+ * Co-applicant fields that can be patched
2089
+ */
2090
+ interface PatchCoApplicant {
2091
+ /** First name */
2092
+ first_name?: string;
2093
+ /** Last name */
2094
+ last_name?: string;
2095
+ /** Email address */
2096
+ email?: string;
2097
+ /** Social Security Number — 9 digits, no dashes */
2098
+ social_security_number?: string;
2099
+ /** Date of birth (YYYY-MM-DD) */
2100
+ date_of_birth?: string;
2101
+ /** FDR applicant identifier for co-applicant */
2102
+ fdr_applicant_id?: string;
2103
+ /** Credit Bureau Report ID for co-applicant */
2104
+ cbr_report_id?: string;
2105
+ /** Whether the co-applicant has filed for bankruptcy */
2106
+ bankruptcy?: boolean;
2107
+ /** Date of co-applicant bankruptcy filing (YYYY-MM-DD) */
2108
+ bankruptcy_date?: string;
2109
+ /** Co-applicant phone number */
2110
+ phone_number?: string;
2111
+ /** Co-applicant mobile phone number */
2112
+ mobile_phone_number?: string;
2113
+ /** Co-applicant primary monthly income */
2114
+ monthly_income?: number;
2115
+ /** Co-applicant other monthly income */
2116
+ other_monthly_income?: number;
2117
+ /** Description of co-applicant other income sources */
2118
+ other_income_description?: string;
2119
+ /** Monthly Social Security income */
2120
+ social_security?: number;
2121
+ /** Monthly retirement income */
2122
+ retirement?: number;
2123
+ /** Monthly dividend income */
2124
+ dividends?: number;
2125
+ /** Monthly annuity income */
2126
+ annuities?: number;
2127
+ /** Monthly other government assistance income */
2128
+ other_government_assistance?: number;
2129
+ /** Monthly child support income received */
2130
+ child_support?: number;
2131
+ /** Monthly alimony income received */
2132
+ alimony?: number;
2133
+ /** Monthly unemployment benefits */
2134
+ unemployment?: number;
2135
+ /** Monthly self-employment / 1099 income */
2136
+ self_employment_1099_income?: number;
2137
+ }
2138
+
2139
+ /**
2140
+ * Generated by orval v7.21.0 🍺
2141
+ * Do not edit manually.
2142
+ * ARPC — Achieve Resolution Partner Connect API
2143
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
2144
+ * OpenAPI spec version: 2026.15.0
2145
+ */
2146
+
2147
+ /**
2148
+ * Partial update request for an existing application / lead record. Only provided fields are updated.
2149
+ */
2150
+ interface LeadPatchRequest {
2151
+ applicant?: PatchApplicant;
2152
+ /** Whether the applicant owns or rents their home */
2153
+ own_or_rent?: string;
2154
+ /** Monthly housing payment */
2155
+ rent_or_mortgage_monthly?: number;
2156
+ /** Desired monthly deposit amount */
2157
+ monthly_deposit?: number;
2158
+ /** Hardship category */
2159
+ hardship_category?: string;
2160
+ /** Free-text hardship description when category is 'Other' */
2161
+ hardship_category_other?: string;
2162
+ /** Goal category */
2163
+ goal_category?: string;
2164
+ /** Free-text goal description when category is 'Other' */
2165
+ goal_category_other?: string;
2166
+ /** Monthly food expenses */
2167
+ food_expenses?: number;
2168
+ /** Monthly utility expenses */
2169
+ utilities?: number;
2170
+ /** Monthly transportation expenses */
2171
+ transportation_expenses?: number;
2172
+ /** Other monthly debt payments not in the enrolled debt list */
2173
+ other_debt_payments?: number;
2174
+ /** Other miscellaneous monthly expenses (USD) */
2175
+ other_expenses_describe?: number;
2176
+ /** Description of other expenses */
2177
+ other_expenses_description?: string;
2178
+ /** Whether the banking disclosure has been completed */
2179
+ banking_disclosure_validation?: boolean;
2180
+ /** Monthly child care expenses */
2181
+ child_care?: number;
2182
+ /** Monthly out-of-pocket medical costs */
2183
+ out_of_pocket_medical_costs?: number;
2184
+ /** Monthly personal care, household and miscellaneous expenses */
2185
+ personal_care_house_hold_and_miscellaneous?: number;
2186
+ /** Monthly government student loan payments (non-deferred) */
2187
+ government_student_loans_non_deferred?: number;
2188
+ /** Monthly private student loan payments (non-deferred) */
2189
+ private_student_loans_non_deferred?: number;
2190
+ /** Monthly legal and court-ordered expenses */
2191
+ legal_and_court_ordered_expenses?: number;
2192
+ /** Total medical debt amount */
2193
+ medical_debt?: number;
2194
+ /** Total business debt amount */
2195
+ business_debt?: number;
2196
+ /** Free-text justification for stated income */
2197
+ income_justification?: string;
2198
+ /** Free-text justification for housing expense */
2199
+ housing_justification?: string;
2200
+ /** Free-text justification for transportation expense */
2201
+ transportation_justification?: string;
2202
+ /** Free-text justification for food expense */
2203
+ food_justification?: string;
2204
+ /** Description of other income sources (root-level) */
2205
+ other_income_description?: string;
2206
+ /** Description of other debt expenses */
2207
+ other_debt_expenses_description?: string;
2208
+ /** Free-text comments on income and expenses */
2209
+ income_expenses_comments?: string;
2210
+ /** Grounds for exception when negative cash flow is detected */
2211
+ negative_cash_flow_grounds_for_exception?: string;
2212
+ /** Applicant salutation */
2213
+ salutation?: string;
2214
+ /** Preferred communication language */
2215
+ language?: string;
2216
+ /** Application state in Salesforce */
2217
+ state?: string;
2218
+ /** Reason the application was marked inactive */
2219
+ inactive_reason?: string;
2220
+ /** Additional details for the inactive reason */
2221
+ inactive_reason_details?: string;
2222
+ /** Applicant mobile phone number (root-level) */
2223
+ mobile_phone_number?: string;
2224
+ /** Applicant evening phone number (root-level) */
2225
+ evening_phone_number?: string;
2226
+ /** Next pay date — root-level override (YYYY-MM-DD) */
2227
+ next_pay_date?: string;
2228
+ /** Pay frequency — root-level override */
2229
+ pay_frequency?: string;
2230
+ /** Email of the seller agent */
2231
+ seller_agent_email?: string;
2232
+ /** Lead-level conditions to verify */
2233
+ conditions?: PatchCondition[];
2234
+ /** Debt accounts with condition updates */
2235
+ debt_accounts?: PatchDebtAccount[];
2236
+ co_applicant?: PatchCoApplicant;
2237
+ }
2238
+
2239
+ /**
2240
+ * Generated by orval v7.21.0 🍺
2241
+ * Do not edit manually.
2242
+ * ARPC — Achieve Resolution Partner Connect API
2243
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
2244
+ * OpenAPI spec version: 2026.15.0
2245
+ */
2246
+
2247
+ /**
2248
+ * Program readiness evaluation result (UW Submission response only)
2249
+ * @nullable
2250
+ */
2251
+ type LeadReadiness = {
2252
+ /** Array of readiness check results */
2253
+ checks?: Check[];
2254
+ /**
2255
+ * Whether a program refresh was required before UW submission could proceed
2256
+ * @nullable
2257
+ */
2258
+ is_program_refresh_required?: boolean | null;
2259
+ /**
2260
+ * Whether UW has previously approved this application
2261
+ * @nullable
2262
+ */
2263
+ is_uw_approved?: boolean | null;
2264
+ } | null;
2265
+
2266
+ /**
2267
+ * Generated by orval v7.21.0 🍺
2268
+ * Do not edit manually.
2269
+ * ARPC — Achieve Resolution Partner Connect API
2270
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
2271
+ * OpenAPI spec version: 2026.15.0
2272
+ */
2273
+
2274
+ /**
2275
+ * Lead / opportunity response returned by GET lead, PATCH lead, and UW Submission endpoints. The readiness field is present only in UW Submission responses.
2276
+ */
2277
+ interface LeadResponse {
2278
+ /** Request correlation / tracking identifier from the Managed Package proxy */
2279
+ id?: string;
2280
+ /** Result message */
2281
+ message?: string;
2282
+ application?: LeadApplication;
2283
+ readiness?: LeadReadiness;
2284
+ }
2285
+
2286
+ /**
2287
+ * Generated by orval v7.21.0 🍺
2288
+ * Do not edit manually.
2289
+ * ARPC — Achieve Resolution Partner Connect API
2290
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
2291
+ * OpenAPI spec version: 2026.15.0
2292
+ */
2293
+ /**
2294
+ * Applicant mailing address.
2295
+ */
2296
+ interface MailingAddress {
2297
+ /** Two-letter US state code */
2298
+ state?: string;
2299
+ /** City name */
2300
+ city?: string;
2301
+ /** 5-digit US ZIP code. */
2302
+ zip_code?: string;
2303
+ /** Street address line 1 */
2304
+ line1?: string;
2305
+ }
2306
+
2307
+ /**
2308
+ * Generated by orval v7.21.0 🍺
2309
+ * Do not edit manually.
2310
+ * ARPC — Achieve Resolution Partner Connect API
2311
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
2312
+ * OpenAPI spec version: 2026.15.0
2313
+ */
2314
+ /**
2315
+ * Marketing tracking metadata
2316
+ */
2317
+ interface Tracking {
2318
+ /** UTM media source */
2319
+ utm_media?: string;
2320
+ /** TrustedForm certificate URL. Set up instructions: https://activeprospect.redoc.ly/docs/trustedform/implementing-trustedform-certify/ */
2321
+ trusted_form_cert?: string;
2322
+ /** UTM campaign identifier */
2323
+ utm_campaign?: string;
2324
+ }
2325
+
2326
+ /**
2327
+ * Generated by orval v7.21.0 🍺
2328
+ * Do not edit manually.
2329
+ * ARPC — Achieve Resolution Partner Connect API
2330
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
2331
+ * OpenAPI spec version: 2026.15.0
2332
+ */
2333
+
2334
+ /**
2335
+ * Lead evaluation payload. fdr_applicant_id is a required routing field. phone_number and zip_code are accepted as standardized field names.
2336
+ */
2337
+ interface LeadTransferRequest {
2338
+ /** FDR applicant identifier used to route the request. */
2339
+ fdr_applicant_id: string;
2340
+ /** Applicant email address */
2341
+ email?: string;
2342
+ /** Primary phone number in E.164 format. */
2343
+ phone_number?: string;
2344
+ /** Applicant first name */
2345
+ first_name?: string;
2346
+ /** Applicant last name */
2347
+ last_name?: string;
2348
+ /** Date of birth in YYYY-MM-DD format */
2349
+ date_of_birth?: string;
2350
+ /** Total unsecured debt amount in USD */
2351
+ unsecured_debt?: number;
2352
+ /** Social Security Number in SSN format (e.g. 123-45-6789). Optional. */
2353
+ social_security_number?: string;
2354
+ mailing_address?: MailingAddress;
2355
+ tracking?: Tracking;
2356
+ consents?: Consents;
2357
+ }
2358
+
2359
+ /**
2360
+ * Generated by orval v7.21.0 🍺
2361
+ * Do not edit manually.
2362
+ * ARPC — Achieve Resolution Partner Connect API
2363
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
2364
+ * OpenAPI spec version: 2026.15.0
2365
+ */
2366
+ /**
2367
+ * Evaluation outcome: 'accepted' or 'rejected'.
2368
+ */
2369
+ type LeadTransferResponseResponse = typeof LeadTransferResponseResponse[keyof typeof LeadTransferResponseResponse];
2370
+ declare const LeadTransferResponseResponse: {
2371
+ readonly accepted: "accepted";
2372
+ readonly rejected: "rejected";
2373
+ };
2374
+
2375
+ /**
2376
+ * Generated by orval v7.21.0 🍺
2377
+ * Do not edit manually.
2378
+ * ARPC — Achieve Resolution Partner Connect API
2379
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
2380
+ * OpenAPI spec version: 2026.15.0
2381
+ */
2382
+
2383
+ /**
2384
+ * Lead evaluation result. Field presence varies between accepted and rejected outcomes.
2385
+ */
2386
+ interface LeadTransferResponse {
2387
+ /**
2388
+ * Evaluation identifier. Present on accepted leads.
2389
+ * @nullable
2390
+ */
2391
+ id?: number | null;
2392
+ /**
2393
+ * ISO-8601 timestamp when the evaluation was created. Present on accepted leads.
2394
+ * @nullable
2395
+ */
2396
+ created_at?: string | null;
2397
+ /**
2398
+ * ISO-8601 timestamp when the evaluation was last updated. Present on accepted leads.
2399
+ * @nullable
2400
+ */
2401
+ updated_at?: string | null;
2402
+ /** Evaluation outcome: 'accepted' or 'rejected'. */
2403
+ response?: LeadTransferResponseResponse;
2404
+ /** Redirect URL for the applicant to view offers. */
2405
+ get_offers_url?: string;
2406
+ /**
2407
+ * Machine-readable reason for rejection. Present on rejected leads.
2408
+ * @nullable
2409
+ */
2410
+ response_reason?: string | null;
2411
+ /**
2412
+ * Human-readable rejection detail messages. Present on rejected leads. May be a plain string or an array of strings.
2413
+ * @nullable
2414
+ */
2415
+ response_details?: (string | null)[] | null;
2416
+ }
2417
+
2418
+ /**
2419
+ * Generated by orval v7.21.0 🍺
2420
+ * Do not edit manually.
2421
+ * ARPC — Achieve Resolution Partner Connect API
2422
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
2423
+ * OpenAPI spec version: 2026.15.0
2424
+ */
2425
+ /**
2426
+ * Request body for async program generation (v1)
2427
+ */
2428
+ interface ProgramRequest {
2429
+ /** The unique FDR applicant ID for the lead to generate a program for */
2430
+ fdr_applicant_id: string;
2431
+ /** Set to true on the final polling attempt to force program calculation regardless of credit status */
2432
+ is_final_retry?: boolean;
2433
+ }
2434
+
2435
+ /**
2436
+ * Generated by orval v7.21.0 🍺
2437
+ * Do not edit manually.
2438
+ * ARPC — Achieve Resolution Partner Connect API
2439
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
2440
+ * OpenAPI spec version: 2026.15.0
2441
+ */
2442
+ /**
2443
+ * Request body for creating a Program Summary Recording task (RWA-2427)
2444
+ */
2445
+ interface ProgramSummaryTaskRequest {
2446
+ /** ISO-8601 timestamp when the recorded call started */
2447
+ start_time?: string;
2448
+ /** ISO-8601 timestamp when the recorded call ended */
2449
+ end_time?: string;
2450
+ /** ISO-8601 timestamp for the PSR event date-time */
2451
+ date_time?: string;
2452
+ /** Free-form comments from the agent. The orchestrator combines this with call timestamps (and optional caller_ip) when generating the SUIP task description. */
2453
+ comments?: string;
2454
+ /** Optional caller-provided originating IP address. When present, this value is appended to the generated task description as 'Caller IP: <value>'. */
2455
+ caller_ip?: string;
2456
+ /** Optional caller-supplied PSC recording code. Honoured only for DC flows: when present the orchestrator patches the parent SF object field WS_PSC_CODE__c with this value; when absent the SUIP task is created without a PSC patch. For DEX flows this field is ignored and the seller-config partner default is always used. */
2457
+ ws_psc_code?: string;
2458
+ }
2459
+
2460
+ /**
2461
+ * Generated by orval v7.21.0 🍺
2462
+ * Do not edit manually.
2463
+ * ARPC — Achieve Resolution Partner Connect API
2464
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
2465
+ * OpenAPI spec version: 2026.15.0
2466
+ */
2467
+ /**
2468
+ * Response body for a successfully created Program Summary Recording task
2469
+ */
2470
+ interface ProgramSummaryTaskResponse {
2471
+ /** Unique identifier for the created task */
2472
+ id?: string;
2473
+ /** Task operation type */
2474
+ type?: string;
2475
+ /** Result status of the task creation */
2476
+ status?: string;
2477
+ /** Human-readable result message */
2478
+ message?: string;
2479
+ /** ISO-8601 timestamp derived from the recording event date_time in the request payload */
2480
+ created_at?: string;
2481
+ /** ISO-8601 timestamp set by SUIP when the Salesforce task was persisted */
2482
+ completed_at?: string;
2483
+ }
2484
+
2485
+ /**
2486
+ * Generated by orval v7.21.0 🍺
2487
+ * Do not edit manually.
2488
+ * ARPC — Achieve Resolution Partner Connect API
2489
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
2490
+ * OpenAPI spec version: 2026.15.0
2491
+ */
2492
+ /**
2493
+ * Error classification code
2494
+ */
2495
+ type ReadinessErrorResponseErrorCode = typeof ReadinessErrorResponseErrorCode[keyof typeof ReadinessErrorResponseErrorCode];
2496
+ declare const ReadinessErrorResponseErrorCode: {
2497
+ readonly ER40301: "ER40301";
2498
+ readonly ER40305: "ER40305";
2499
+ };
2500
+
2501
+ /**
2502
+ * Generated by orval v7.21.0 🍺
2503
+ * Do not edit manually.
2504
+ * ARPC — Achieve Resolution Partner Connect API
2505
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
2506
+ * OpenAPI spec version: 2026.15.0
2507
+ */
2508
+
2509
+ /**
2510
+ * Error response for readiness gate failures. Includes per-check detail for UW and DRA gates.
2511
+ */
2512
+ interface ReadinessErrorResponse {
2513
+ /** UTC timestamp of the error */
2514
+ timestamp?: string;
2515
+ /** HTTP status code */
2516
+ status?: number;
2517
+ /** Short error message */
2518
+ error?: string;
2519
+ /** Error classification code */
2520
+ error_code?: ReadinessErrorResponseErrorCode;
2521
+ /** Correlation ID for distributed tracing */
2522
+ x_correlation_id?: string;
2523
+ error_details?: ErrorDetails;
2524
+ }
2525
+
2526
+ /**
2527
+ * Generated by orval v7.21.0 🍺
2528
+ * Do not edit manually.
2529
+ * ARPC — Achieve Resolution Partner Connect API
2530
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
2531
+ * OpenAPI spec version: 2026.15.0
2532
+ */
2533
+
2534
+ /**
2535
+ * Result of a readiness pre-flight check
2536
+ */
2537
+ interface ReadinessResponse {
2538
+ /** Array of individual readiness check results */
2539
+ checks?: ReadinessCheck[];
2540
+ /**
2541
+ * Whether a program refresh is required before proceeding
2542
+ * @nullable
2543
+ */
2544
+ is_program_refresh_required?: boolean | null;
2545
+ /**
2546
+ * Whether UW has previously approved this application
2547
+ * @nullable
2548
+ */
2549
+ is_uw_approved?: boolean | null;
2550
+ }
2551
+
2552
+ /**
2553
+ * Generated by orval v7.21.0 🍺
2554
+ * Do not edit manually.
2555
+ * ARPC — Achieve Resolution Partner Connect API
2556
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
2557
+ * OpenAPI spec version: 2026.15.0
2558
+ */
2559
+ /**
2560
+ * Response returned after successfully registering an applicant
2561
+ */
2562
+ interface RegisterApplicantResponse {
2563
+ /** Registration status */
2564
+ status?: string;
2565
+ /** Business flow / seller identifier derived from the OAuth token used (e.g. SSI, TTTM) */
2566
+ business_flow?: string;
2567
+ /** Salesforce ID of the created achieve__Applicant__c record */
2568
+ salesforce_id?: string;
2569
+ }
2570
+
2571
+ /**
2572
+ * Generated by orval v7.21.0 🍺
2573
+ * Do not edit manually.
2574
+ * ARPC — Achieve Resolution Partner Connect API
2575
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
2576
+ * OpenAPI spec version: 2026.15.0
2577
+ */
2578
+
2579
+ /**
2580
+ * Request body for registering a new applicant in the v2 DEX surface
2581
+ */
2582
+ interface RegisterApplicantV2Request {
2583
+ /** Email of the seller agent to be set as the Salesforce record owner */
2584
+ seller_agent_email?: string;
2585
+ applicant?: Applicant;
2586
+ }
2587
+
2588
+ /**
2589
+ * Generated by orval v7.21.0 🍺
2590
+ * Do not edit manually.
2591
+ * ARPC — Achieve Resolution Partner Connect API
2592
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
2593
+ * OpenAPI spec version: 2026.15.0
2594
+ */
2595
+
2596
+ /**
2597
+ * Request body to create or connect a Spinwheel network user for an applicant
2598
+ */
2599
+ interface SpinwheelNetworkUserRequest {
2600
+ /** FDR applicant identifier. Optional — used to link the Spinwheel network user to an existing lead when known. */
2601
+ fdr_applicant_id?: string;
2602
+ /** Two-letter US state code for the applicant */
2603
+ state: string;
2604
+ /** Last 4 digits of the applicant's SSN */
2605
+ ssn: string;
2606
+ /** Spinwheel network user token obtained from the Spinwheel SDK */
2607
+ network_user_token: string;
2608
+ /** Applicant date of birth (ISO-8601) */
2609
+ date_of_birth: string;
2610
+ audit: AuditInfo;
2611
+ }
2612
+
2613
+ /**
2614
+ * Generated by orval v7.21.0 🍺
2615
+ * Do not edit manually.
2616
+ * ARPC — Achieve Resolution Partner Connect API
2617
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
2618
+ * OpenAPI spec version: 2026.15.0
2619
+ */
2620
+ /**
2621
+ * Result of creating or connecting a Spinwheel network user
2622
+ */
2623
+ interface SpinwheelNetworkUserResponse {
2624
+ /** The FDR applicant ID associated with the Spinwheel user */
2625
+ fdr_applicant_id?: string;
2626
+ /** Status message */
2627
+ message?: string;
2628
+ }
2629
+
2630
+ /**
2631
+ * Generated by orval v7.21.0 🍺
2632
+ * Do not edit manually.
2633
+ * ARPC — Achieve Resolution Partner Connect API
2634
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
2635
+ * OpenAPI spec version: 2026.15.0
2636
+ */
2637
+
2638
+ /**
2639
+ * Request body for the stateless application readiness pre-flight check
2640
+ */
2641
+ interface StatelessReadinessRequest {
2642
+ /** Seller-assigned lead reference ID */
2643
+ reference_id?: string;
2644
+ /** Email of the seller agent */
2645
+ seller_agent_email?: string;
2646
+ /** Credit pull source identifier */
2647
+ credit_pull_source?: string;
2648
+ /** Whether the lead is currently marked eligible */
2649
+ eligible?: boolean;
2650
+ /** Monthly other debt payment expenses */
2651
+ other_debt_payments?: number;
2652
+ /** Monthly utilities expenses */
2653
+ utilities?: number;
2654
+ /** Monthly food expenses */
2655
+ food_expenses?: number;
2656
+ /** Whether the applicant owns or rents their home */
2657
+ own_or_rent?: string;
2658
+ /** Monthly rent or mortgage payment */
2659
+ rent_or_mortgage_monthly?: number;
2660
+ /** Monthly transportation expenses */
2661
+ transportation_expenses?: number;
2662
+ /** Other miscellaneous monthly expenses (USD) */
2663
+ other_expenses_describe?: number;
2664
+ /** Monthly non-deferred government student loan payments */
2665
+ government_student_loans_non_deferred?: number;
2666
+ /** Monthly non-deferred private student loan payments */
2667
+ private_student_loans_non_deferred?: number;
2668
+ /** Monthly legal and court-ordered expenses */
2669
+ legal_and_court_ordered_expenses?: number;
2670
+ /** Total medical debt amount */
2671
+ medical_debt?: number;
2672
+ /** Total business debt amount */
2673
+ business_debt?: number;
2674
+ /** Primary hardship category */
2675
+ hardship_category?: string;
2676
+ /** Free-text description when hardship category is 'other' */
2677
+ hardship_category_other?: string;
2678
+ /** Primary goal category */
2679
+ goal_category?: string;
2680
+ /** Free-text description when goal category is 'other' */
2681
+ goal_category_other?: string;
2682
+ /** Justification for food expense amount */
2683
+ food_justification?: string;
2684
+ /** Justification for housing expense amount */
2685
+ housing_justification?: string;
2686
+ /** Justification for transportation expense amount */
2687
+ transportation_justification?: string;
2688
+ /** Justification for income amount */
2689
+ income_justification?: string;
2690
+ /** Description of other debt-related expenses */
2691
+ other_debt_expenses_description?: string;
2692
+ /** Description of other miscellaneous expenses */
2693
+ other_expenses_description?: string;
2694
+ /** Free-text comments on income and expenses */
2695
+ income_expenses_comments?: string;
2696
+ /** Total cost if the applicant does nothing (minimum payments) */
2697
+ do_nothing_total_cost?: number;
2698
+ /** Monthly bank service fee */
2699
+ bank_service_fee?: number;
2700
+ /** Estimated program length in months (primary option) */
2701
+ estimated_program_length?: number;
2702
+ /** Estimated program length — option 1 */
2703
+ estimated_program_length_option_1?: number;
2704
+ /** Estimated program length — option 2 */
2705
+ estimated_program_length_option_2?: number;
2706
+ /** Estimated program length — option 3 */
2707
+ estimated_program_length_option_3?: number;
2708
+ /** Monthly deposit amount (primary program option) */
2709
+ monthly_deposit?: number;
2710
+ /** Estimated monthly payment (primary option) */
2711
+ estimated_monthly_payment?: number;
2712
+ /** Estimated monthly payment — option 1 */
2713
+ estimated_monthly_payment_option_1?: number;
2714
+ /** Estimated monthly payment — option 2 */
2715
+ estimated_monthly_payment_option_2?: number;
2716
+ /** Estimated monthly payment — option 3 */
2717
+ estimated_monthly_payment_option_3?: number;
2718
+ /** Total estimated cost — option 1 */
2719
+ estimated_cost_option_1?: number;
2720
+ /** Total estimated cost — option 2 */
2721
+ estimated_cost_option_2?: number;
2722
+ /** Total estimated cost — option 3 */
2723
+ estimated_cost_option_3?: number;
2724
+ /** Estimated total cost to client */
2725
+ estimated_cost_to_client?: number;
2726
+ /** Estimated total program cost */
2727
+ estimated_program_cost?: number;
2728
+ /** Estimated savings vs. do-nothing path */
2729
+ estimated_program_savings?: number;
2730
+ /** Total estimated enrollable debt */
2731
+ estimated_total_debt?: number;
2732
+ /** Estimated settlement amount */
2733
+ estimated_settlement?: number;
2734
+ /** Estimated total monthly creditor payment (minimum payments) */
2735
+ estimated_monthly_creditor_payment?: number;
2736
+ /** Estimated time to first settlement (primary option) */
2737
+ estimated_time_to_first_settlement?: string;
2738
+ /** Estimated time to first settlement — option 1 */
2739
+ estimated_time_to_first_settlement_option_1?: string;
2740
+ /** Estimated time to first settlement — option 2 */
2741
+ estimated_time_to_first_settlement_option_2?: string;
2742
+ /** Estimated time to first settlement — option 3 */
2743
+ estimated_time_to_first_settlement_option_3?: string;
2744
+ /** Total program fee */
2745
+ fee_total?: number;
2746
+ /** Program fee as a percentage of enrolled debt */
2747
+ fee_percentage?: number;
2748
+ /** Fee charges if applicant had continued minimum payments */
2749
+ fee_charges_minimum_payments?: number;
2750
+ /** Fee savings compared to minimum payments path */
2751
+ fee_savings_vs_min_payments?: number;
2752
+ /** Total savings vs. do-nothing cost */
2753
+ savings_off_do_nothing_cost?: number;
2754
+ /** Months to pay off debt via minimum payments */
2755
+ pay_down_time_minimum_payments?: number;
2756
+ /** Months saved vs. minimum payment path */
2757
+ program_time_savings_vs_minimum_payments?: number;
2758
+ /** Program payment options (3 tiers) */
2759
+ payment_options?: PaymentOption[];
2760
+ applicant?: LeadApplicantInput;
2761
+ /** List of debt accounts submitted for readiness evaluation */
2762
+ debt_accounts?: DebtAccount[];
2763
+ /** Readiness gate conditions */
2764
+ conditions?: LeadCondition[];
2765
+ }
2766
+
2767
+ /**
2768
+ * Generated by orval v7.21.0 🍺
2769
+ * Do not edit manually.
2770
+ * ARPC — Achieve Resolution Partner Connect API
2771
+ * FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
2772
+ * OpenAPI spec version: 2026.15.0
2773
+ */
2774
+
2775
+ /**
2776
+ * UW Submission V2 response. Mirrors the standard lead response shape and adds two banking-disclosure outcome fields. Banking disclosure email is sent automatically on full UW approval (sub_status = 'UW Approved') and suppressed for conditional approvals.
2777
+ */
2778
+ interface UwSubmissionV2Response {
2779
+ /** Request correlation / tracking identifier from the Managed Package proxy */
2780
+ id?: string;
2781
+ /** Result message */
2782
+ message?: string;
2783
+ application?: LeadApplication;
2784
+ readiness?: LeadReadiness;
2785
+ /** True when the banking disclosure email was sent successfully. False when the email was intentionally suppressed (e.g. conditional approval) or the downstream email service failed (failure is non-blocking). */
2786
+ banking_disclosure_email_sent?: boolean;
2787
+ /**
2788
+ * Human-readable outcome of the banking disclosure email step — success confirmation, suppression reason, or downstream failure cause. Omitted when sent successfully in some flows.
2789
+ * @nullable
2790
+ */
2791
+ banking_disclosure_email_message?: string | null;
2792
+ }
2793
+
2794
+ /**
2795
+ * ARPC SDK — a typed, agnostic client for FDR's ARPC DEX API (Achieve
2796
+ * Resolution Partner Connect, Digital Enrollment Experience).
2797
+ *
2798
+ * Thin by design: it owns the two-host routing, the OAuth token lifecycle, and
2799
+ * bearer injection, and exposes the full endpoint surface as typed operations
2800
+ * on `sdk.api`. It does not orchestrate the enrollment sequence — the caller
2801
+ * assembles payloads and threads the `fdr_applicant_id` between calls. See
2802
+ * `scripts/smoke.ts` for a full end-to-end reference sequence (incl. the program
2803
+ * poll loop).
2804
+ *
2805
+ * Operations never throw on a non-2xx: each returns `{ status, data, headers }`,
2806
+ * so a business gate (e.g. a UW/DRA readiness failure) comes back as a normal
2807
+ * response you inspect via `status`/`data`. Only transport errors throw.
2808
+ *
2809
+ * Note: config and the bearer token are process-global — construct one `ArpcSDK`
2810
+ * per process. A second instance reconfigures the first; instances are not
2811
+ * isolated (single-tenant by design).
2812
+ *
2813
+ * @example
2814
+ * ```typescript
2815
+ * const sdk = new ArpcSDK({
2816
+ * oauthUrl: "https://oauth.stg.ffngcp.com",
2817
+ * gatewayUrl: "https://apis-gateway-v2.stg.fdrgcp.com",
2818
+ * username: "borrowbetter@seller.com",
2819
+ * password: process.env.FDR_OAUTH_PASSWORD!,
2820
+ * });
2821
+ *
2822
+ * await sdk.authenticate();
2823
+ * const elig = await sdk.api.checkEligibility({ ... });
2824
+ * const faid = elig.data.application?.applicant?.fdr_applicant_id;
2825
+ * ```
2826
+ */
2827
+ declare class ArpcSDK {
2828
+ /** The full typed endpoint surface — one method per gateway operation. */
2829
+ readonly api: {
2830
+ createLeadSync: (createLeadRequest: CreateLeadRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<CreateLeadResponse>>;
2831
+ checkApplicationReadiness: (statelessReadinessRequest: StatelessReadinessRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<ReadinessResponse>>;
2832
+ createSpinwheelNetworkUser: (spinwheelNetworkUserRequest: SpinwheelNetworkUserRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<SpinwheelNetworkUserResponse>>;
2833
+ updateApplicationBankDetails: (applicantId: string, bankUpdateRequest: BankUpdateRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<LeadResponse>>;
2834
+ sendEmail: (fdrApplicantId: string, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<ApplicationSendEmailResponse>>;
2835
+ leadTransfer: (leadTransferRequest: LeadTransferRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<LeadTransferResponse>>;
2836
+ readLead: (fdrApplicantId: string, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<LeadResponse>>;
2837
+ patchLead: (fdrApplicantId: string, leadPatchRequest: LeadPatchRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<LeadResponse>>;
2838
+ getApplicationReadiness: (applicantId: string, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<ReadinessResponse>>;
2839
+ generateDra: (applicantId: string, draRequest: DraRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<DraResponse>>;
2840
+ registerApplicantV2: (registerApplicantV2Request: RegisterApplicantV2Request, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<RegisterApplicantResponse>>;
2841
+ generateProgramV1: (programRequest: ProgramRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<LeadResponse>>;
2842
+ checkEligibility: (eligibilityRequest: EligibilityRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<EligibilityResponse>>;
2843
+ uwSubmissionV2: (fdrApplicantId: string, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<UwSubmissionV2Response>>;
2844
+ createProgramSummaryTask: (id: string, programSummaryTaskRequest: ProgramSummaryTaskRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<ProgramSummaryTaskResponse>>;
2845
+ };
2846
+ constructor(config: ArpcConfig);
2847
+ /**
2848
+ * Exchange OAuth client credentials for a bearer JWT and store it for
2849
+ * subsequent `api` calls. Token TTL is ~900s — re-call to refresh.
2850
+ */
2851
+ authenticate(): Promise<TokenResponse>;
2852
+ }
2853
+
2854
+ export { type ARPCErrorResponse, type Address, type Applicant, type ApplicationSendEmailResponse, type ArpcConfig, ArpcSDK, type AuditInfo, type BankDetails, type BankDetailsInput, type BankUpdateRequest, type Check, CheckType, type CoApplicant, type Consents, type CreateLeadRequest, type CreateLeadResponse, type CreditPullConsent, type DebtAccount, type DraApplicant, type DraApplicantInput, DraApplicantInputSigningType, type DraRequest, type DraResponse, type EligibilityAddress, type EligibilityApplicant, type EligibilityApplication, type EligibilityDebtAccount, type EligibilityRequest, type EligibilityResponse, type ErrorDetails, type FieldValidationError, FieldValidationErrorReasonCode, type HttpResponse, type IneligibleReason, type LeadApplicant, LeadApplicantEmploymentStatus, type LeadApplicantInput, LeadApplicantPayFrequency, type LeadApplication, LeadApplicationCreditPullSource, LeadApplicationFdrOrCss, LeadApplicationFixedIncome, LeadApplicationOwnOrRent, type LeadCondition, LeadConditionActive, type LeadCreditor, type LeadDebtAccount, LeadDebtAccountOwnership, LeadDebtAccountResponsibility, type LeadDistribution, type LeadPatchRequest, type LeadReadiness, type LeadResponse, type LeadTransferRequest, type LeadTransferResponse, LeadTransferResponseResponse, type MailingAddress, type PatchAddress, type PatchApplicant, type PatchCoApplicant, type PatchCondition, type PatchDebtAccount, type PaymentOption, type ProgramRequest, type ProgramSummaryTaskRequest, type ProgramSummaryTaskResponse, type ReadinessCheck, ReadinessCheckType, type ReadinessErrorResponse, ReadinessErrorResponseErrorCode, type ReadinessResponse, type RegisterApplicantResponse, type RegisterApplicantV2Address, type RegisterApplicantV2Request, type SpinwheelNetworkUserRequest, type SpinwheelNetworkUserResponse, type StatelessReadinessRequest, type TokenResponse, type Tracking, type UwSubmissionV2Response };