@borrowbetter/arpcsdk 0.3.0 → 0.4.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.
- package/README.md +62 -4
- package/dist/index.d.mts +1104 -154
- package/dist/index.d.ts +1104 -154
- package/dist/index.js +31 -1
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +29 -2
- package/dist/index.mjs.map +1 -1
- package/package.json +2 -2
package/dist/index.d.mts
CHANGED
|
@@ -89,7 +89,9 @@ interface ArpcConfig {
|
|
|
89
89
|
* Do not edit manually.
|
|
90
90
|
* ARPC — Achieve Resolution Partner Connect API
|
|
91
91
|
* 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.
|
|
92
|
-
|
|
92
|
+
|
|
93
|
+
**Published:** 2026-08-08
|
|
94
|
+
* OpenAPI spec version: 2026.16.0
|
|
93
95
|
*/
|
|
94
96
|
/**
|
|
95
97
|
* Stable machine-readable reason for the violation. See ValidationReasonCode.
|
|
@@ -109,7 +111,9 @@ declare const FieldValidationErrorReasonCode: {
|
|
|
109
111
|
* Do not edit manually.
|
|
110
112
|
* ARPC — Achieve Resolution Partner Connect API
|
|
111
113
|
* 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.
|
|
112
|
-
|
|
114
|
+
|
|
115
|
+
**Published:** 2026-08-08
|
|
116
|
+
* OpenAPI spec version: 2026.16.0
|
|
113
117
|
*/
|
|
114
118
|
|
|
115
119
|
/**
|
|
@@ -129,7 +133,9 @@ interface FieldValidationError {
|
|
|
129
133
|
* Do not edit manually.
|
|
130
134
|
* ARPC — Achieve Resolution Partner Connect API
|
|
131
135
|
* 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.
|
|
132
|
-
|
|
136
|
+
|
|
137
|
+
**Published:** 2026-08-08
|
|
138
|
+
* OpenAPI spec version: 2026.16.0
|
|
133
139
|
*/
|
|
134
140
|
|
|
135
141
|
/**
|
|
@@ -157,7 +163,9 @@ interface ARPCErrorResponse {
|
|
|
157
163
|
* Do not edit manually.
|
|
158
164
|
* ARPC — Achieve Resolution Partner Connect API
|
|
159
165
|
* 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.
|
|
160
|
-
|
|
166
|
+
|
|
167
|
+
**Published:** 2026-08-08
|
|
168
|
+
* OpenAPI spec version: 2026.16.0
|
|
161
169
|
*/
|
|
162
170
|
/**
|
|
163
171
|
* Street address
|
|
@@ -180,7 +188,9 @@ interface Address {
|
|
|
180
188
|
* Do not edit manually.
|
|
181
189
|
* ARPC — Achieve Resolution Partner Connect API
|
|
182
190
|
* 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.
|
|
183
|
-
|
|
191
|
+
|
|
192
|
+
**Published:** 2026-08-08
|
|
193
|
+
* OpenAPI spec version: 2026.16.0
|
|
184
194
|
*/
|
|
185
195
|
/**
|
|
186
196
|
* Address used by v2. ZIP is exposed as zip_code on the public request.
|
|
@@ -193,7 +203,7 @@ interface RegisterApplicantV2Address {
|
|
|
193
203
|
/** US state code — 2 characters */
|
|
194
204
|
state: string;
|
|
195
205
|
/** 5-digit ZIP code */
|
|
196
|
-
zip_code
|
|
206
|
+
zip_code: string;
|
|
197
207
|
/** Country code */
|
|
198
208
|
country?: string;
|
|
199
209
|
}
|
|
@@ -203,7 +213,9 @@ interface RegisterApplicantV2Address {
|
|
|
203
213
|
* Do not edit manually.
|
|
204
214
|
* ARPC — Achieve Resolution Partner Connect API
|
|
205
215
|
* 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.
|
|
206
|
-
|
|
216
|
+
|
|
217
|
+
**Published:** 2026-08-08
|
|
218
|
+
* OpenAPI spec version: 2026.16.0
|
|
207
219
|
*/
|
|
208
220
|
|
|
209
221
|
/**
|
|
@@ -221,7 +233,7 @@ interface Applicant {
|
|
|
221
233
|
/** Secondary / evening phone number (required, 10 digits) */
|
|
222
234
|
evening_phone_number: string;
|
|
223
235
|
/**
|
|
224
|
-
* Social Security Number — exactly 9 numeric digits, no dashes.
|
|
236
|
+
* Social Security Number — exactly 9 numeric digits, no dashes. Required when Spinwheel is used as the credit bureau; optional for any other bureau.
|
|
225
237
|
* @pattern ^\d{9}$
|
|
226
238
|
*/
|
|
227
239
|
ssn: string;
|
|
@@ -229,7 +241,7 @@ interface Applicant {
|
|
|
229
241
|
fdr_applicant_id?: string;
|
|
230
242
|
/** Seller-assigned applicant reference ID */
|
|
231
243
|
reference_id?: string;
|
|
232
|
-
/** Date the applicant gave user consent (
|
|
244
|
+
/** Date the applicant gave user consent (YYYY-MM-DD) */
|
|
233
245
|
consent_date: string;
|
|
234
246
|
/** Applicant date of birth (YYYY-MM-DD, required) */
|
|
235
247
|
date_of_birth: string;
|
|
@@ -244,7 +256,9 @@ interface Applicant {
|
|
|
244
256
|
* Do not edit manually.
|
|
245
257
|
* ARPC — Achieve Resolution Partner Connect API
|
|
246
258
|
* 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.
|
|
247
|
-
|
|
259
|
+
|
|
260
|
+
**Published:** 2026-08-08
|
|
261
|
+
* OpenAPI spec version: 2026.16.0
|
|
248
262
|
*/
|
|
249
263
|
interface ApplicationSendEmailResponse {
|
|
250
264
|
status?: string;
|
|
@@ -258,7 +272,9 @@ interface ApplicationSendEmailResponse {
|
|
|
258
272
|
* Do not edit manually.
|
|
259
273
|
* ARPC — Achieve Resolution Partner Connect API
|
|
260
274
|
* 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.
|
|
261
|
-
|
|
275
|
+
|
|
276
|
+
**Published:** 2026-08-08
|
|
277
|
+
* OpenAPI spec version: 2026.16.0
|
|
262
278
|
*/
|
|
263
279
|
/**
|
|
264
280
|
* Audit metadata
|
|
@@ -273,7 +289,45 @@ interface AuditInfo {
|
|
|
273
289
|
* Do not edit manually.
|
|
274
290
|
* ARPC — Achieve Resolution Partner Connect API
|
|
275
291
|
* 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.
|
|
276
|
-
|
|
292
|
+
|
|
293
|
+
**Published:** 2026-08-08
|
|
294
|
+
* OpenAPI spec version: 2026.16.0
|
|
295
|
+
*/
|
|
296
|
+
/**
|
|
297
|
+
* Account type
|
|
298
|
+
*/
|
|
299
|
+
type BankDetailsAccountType = typeof BankDetailsAccountType[keyof typeof BankDetailsAccountType];
|
|
300
|
+
declare const BankDetailsAccountType: {
|
|
301
|
+
readonly Checking: "Checking";
|
|
302
|
+
readonly Savings: "Savings";
|
|
303
|
+
};
|
|
304
|
+
|
|
305
|
+
/**
|
|
306
|
+
* Generated by orval v7.21.0 🍺
|
|
307
|
+
* Do not edit manually.
|
|
308
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
309
|
+
* 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.
|
|
310
|
+
|
|
311
|
+
**Published:** 2026-08-08
|
|
312
|
+
* OpenAPI spec version: 2026.16.0
|
|
313
|
+
*/
|
|
314
|
+
/**
|
|
315
|
+
* Account sub-type
|
|
316
|
+
*/
|
|
317
|
+
type BankDetailsAccountSubtype = typeof BankDetailsAccountSubtype[keyof typeof BankDetailsAccountSubtype];
|
|
318
|
+
declare const BankDetailsAccountSubtype: {
|
|
319
|
+
readonly Business: "Business";
|
|
320
|
+
readonly Personal: "Personal";
|
|
321
|
+
};
|
|
322
|
+
|
|
323
|
+
/**
|
|
324
|
+
* Generated by orval v7.21.0 🍺
|
|
325
|
+
* Do not edit manually.
|
|
326
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
327
|
+
* 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.
|
|
328
|
+
|
|
329
|
+
**Published:** 2026-08-08
|
|
330
|
+
* OpenAPI spec version: 2026.16.0
|
|
277
331
|
*/
|
|
278
332
|
|
|
279
333
|
/**
|
|
@@ -284,9 +338,9 @@ type BankDetails = {
|
|
|
284
338
|
/** Bank name */
|
|
285
339
|
name?: string;
|
|
286
340
|
/** Account type */
|
|
287
|
-
account_type?:
|
|
341
|
+
account_type?: BankDetailsAccountType;
|
|
288
342
|
/** Account sub-type */
|
|
289
|
-
account_subtype?:
|
|
343
|
+
account_subtype?: BankDetailsAccountSubtype;
|
|
290
344
|
/** Bank account number */
|
|
291
345
|
account_number?: string;
|
|
292
346
|
/** Bank routing number */
|
|
@@ -313,7 +367,9 @@ type BankDetails = {
|
|
|
313
367
|
* Do not edit manually.
|
|
314
368
|
* ARPC — Achieve Resolution Partner Connect API
|
|
315
369
|
* 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.
|
|
316
|
-
|
|
370
|
+
|
|
371
|
+
**Published:** 2026-08-08
|
|
372
|
+
* OpenAPI spec version: 2026.16.0
|
|
317
373
|
*/
|
|
318
374
|
/**
|
|
319
375
|
* Bank account input fields
|
|
@@ -330,7 +386,9 @@ interface BankDetailsInput {
|
|
|
330
386
|
* Do not edit manually.
|
|
331
387
|
* ARPC — Achieve Resolution Partner Connect API
|
|
332
388
|
* 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.
|
|
333
|
-
|
|
389
|
+
|
|
390
|
+
**Published:** 2026-08-08
|
|
391
|
+
* OpenAPI spec version: 2026.16.0
|
|
334
392
|
*/
|
|
335
393
|
|
|
336
394
|
/**
|
|
@@ -349,7 +407,9 @@ interface BankUpdateRequest {
|
|
|
349
407
|
* Do not edit manually.
|
|
350
408
|
* ARPC — Achieve Resolution Partner Connect API
|
|
351
409
|
* 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.
|
|
352
|
-
|
|
410
|
+
|
|
411
|
+
**Published:** 2026-08-08
|
|
412
|
+
* OpenAPI spec version: 2026.16.0
|
|
353
413
|
*/
|
|
354
414
|
/**
|
|
355
415
|
* Check type identifier
|
|
@@ -365,7 +425,9 @@ declare const CheckType: {
|
|
|
365
425
|
* Do not edit manually.
|
|
366
426
|
* ARPC — Achieve Resolution Partner Connect API
|
|
367
427
|
* 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.
|
|
368
|
-
|
|
428
|
+
|
|
429
|
+
**Published:** 2026-08-08
|
|
430
|
+
* OpenAPI spec version: 2026.16.0
|
|
369
431
|
*/
|
|
370
432
|
|
|
371
433
|
/**
|
|
@@ -388,7 +450,9 @@ interface Check {
|
|
|
388
450
|
* Do not edit manually.
|
|
389
451
|
* ARPC — Achieve Resolution Partner Connect API
|
|
390
452
|
* 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.
|
|
391
|
-
|
|
453
|
+
|
|
454
|
+
**Published:** 2026-08-08
|
|
455
|
+
* OpenAPI spec version: 2026.16.0
|
|
392
456
|
*/
|
|
393
457
|
|
|
394
458
|
/**
|
|
@@ -456,7 +520,9 @@ interface CoApplicant {
|
|
|
456
520
|
* Do not edit manually.
|
|
457
521
|
* ARPC — Achieve Resolution Partner Connect API
|
|
458
522
|
* 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.
|
|
459
|
-
|
|
523
|
+
|
|
524
|
+
**Published:** 2026-08-08
|
|
525
|
+
* OpenAPI spec version: 2026.16.0
|
|
460
526
|
*/
|
|
461
527
|
/**
|
|
462
528
|
* Required consent strings for regulatory and platform compliance
|
|
@@ -479,7 +545,9 @@ interface Consents {
|
|
|
479
545
|
* Do not edit manually.
|
|
480
546
|
* ARPC — Achieve Resolution Partner Connect API
|
|
481
547
|
* 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.
|
|
482
|
-
|
|
548
|
+
|
|
549
|
+
**Published:** 2026-08-08
|
|
550
|
+
* OpenAPI spec version: 2026.16.0
|
|
483
551
|
*/
|
|
484
552
|
/**
|
|
485
553
|
* Lead distribution routing configuration
|
|
@@ -496,7 +564,51 @@ interface LeadDistribution {
|
|
|
496
564
|
* Do not edit manually.
|
|
497
565
|
* ARPC — Achieve Resolution Partner Connect API
|
|
498
566
|
* 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.
|
|
499
|
-
|
|
567
|
+
|
|
568
|
+
**Published:** 2026-08-08
|
|
569
|
+
* OpenAPI spec version: 2026.16.0
|
|
570
|
+
*/
|
|
571
|
+
/**
|
|
572
|
+
* Primary hardship category
|
|
573
|
+
*/
|
|
574
|
+
type CreateLeadRequestHardshipCategory = typeof CreateLeadRequestHardshipCategory[keyof typeof CreateLeadRequestHardshipCategory];
|
|
575
|
+
declare const CreateLeadRequestHardshipCategory: {
|
|
576
|
+
readonly Job_Loss: "Job Loss";
|
|
577
|
+
readonly Reduced_Income: "Reduced Income";
|
|
578
|
+
readonly Medical: "Medical";
|
|
579
|
+
readonly Divorce: "Divorce";
|
|
580
|
+
readonly Unexpected_Expenses: "Unexpected Expenses";
|
|
581
|
+
readonly Other: "Other";
|
|
582
|
+
};
|
|
583
|
+
|
|
584
|
+
/**
|
|
585
|
+
* Generated by orval v7.21.0 🍺
|
|
586
|
+
* Do not edit manually.
|
|
587
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
588
|
+
* 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.
|
|
589
|
+
|
|
590
|
+
**Published:** 2026-08-08
|
|
591
|
+
* OpenAPI spec version: 2026.16.0
|
|
592
|
+
*/
|
|
593
|
+
/**
|
|
594
|
+
* Primary goal category
|
|
595
|
+
*/
|
|
596
|
+
type CreateLeadRequestGoalCategory = typeof CreateLeadRequestGoalCategory[keyof typeof CreateLeadRequestGoalCategory];
|
|
597
|
+
declare const CreateLeadRequestGoalCategory: {
|
|
598
|
+
readonly Avoid_Bankruptcy: "Avoid Bankruptcy";
|
|
599
|
+
readonly Get_out_of_Debt: "Get out of Debt";
|
|
600
|
+
readonly 'Build_personal_wealth,_savings': "Build personal wealth, savings";
|
|
601
|
+
readonly Relieve_pressure_of_monthly_bills: "Relieve pressure of monthly bills";
|
|
602
|
+
};
|
|
603
|
+
|
|
604
|
+
/**
|
|
605
|
+
* Generated by orval v7.21.0 🍺
|
|
606
|
+
* Do not edit manually.
|
|
607
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
608
|
+
* 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.
|
|
609
|
+
|
|
610
|
+
**Published:** 2026-08-08
|
|
611
|
+
* OpenAPI spec version: 2026.16.0
|
|
500
612
|
*/
|
|
501
613
|
|
|
502
614
|
/**
|
|
@@ -574,7 +686,9 @@ interface LeadApplicantInput {
|
|
|
574
686
|
* Do not edit manually.
|
|
575
687
|
* ARPC — Achieve Resolution Partner Connect API
|
|
576
688
|
* 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.
|
|
577
|
-
|
|
689
|
+
|
|
690
|
+
**Published:** 2026-08-08
|
|
691
|
+
* OpenAPI spec version: 2026.16.0
|
|
578
692
|
*/
|
|
579
693
|
/**
|
|
580
694
|
* Whether the condition is currently active
|
|
@@ -590,7 +704,29 @@ declare const LeadConditionActive: {
|
|
|
590
704
|
* Do not edit manually.
|
|
591
705
|
* ARPC — Achieve Resolution Partner Connect API
|
|
592
706
|
* 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.
|
|
593
|
-
|
|
707
|
+
|
|
708
|
+
**Published:** 2026-08-08
|
|
709
|
+
* OpenAPI spec version: 2026.16.0
|
|
710
|
+
*/
|
|
711
|
+
/**
|
|
712
|
+
* Condition type. soft-condition types omit the verified field in the response.
|
|
713
|
+
*/
|
|
714
|
+
type LeadConditionType = typeof LeadConditionType[keyof typeof LeadConditionType];
|
|
715
|
+
declare const LeadConditionType: {
|
|
716
|
+
readonly 'soft-condition': "soft-condition";
|
|
717
|
+
readonly 'hard-condition': "hard-condition";
|
|
718
|
+
readonly waiver: "waiver";
|
|
719
|
+
readonly acknowledgement: "acknowledgement";
|
|
720
|
+
};
|
|
721
|
+
|
|
722
|
+
/**
|
|
723
|
+
* Generated by orval v7.21.0 🍺
|
|
724
|
+
* Do not edit manually.
|
|
725
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
726
|
+
* 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.
|
|
727
|
+
|
|
728
|
+
**Published:** 2026-08-08
|
|
729
|
+
* OpenAPI spec version: 2026.16.0
|
|
594
730
|
*/
|
|
595
731
|
|
|
596
732
|
/**
|
|
@@ -605,7 +741,7 @@ type LeadCondition = {
|
|
|
605
741
|
/** Whether the condition is currently active */
|
|
606
742
|
active?: LeadConditionActive;
|
|
607
743
|
/** Condition type. soft-condition types omit the verified field in the response. */
|
|
608
|
-
type?:
|
|
744
|
+
type?: LeadConditionType;
|
|
609
745
|
/**
|
|
610
746
|
* Whether the condition has been verified by underwriting. Absent for soft-condition type.
|
|
611
747
|
* @nullable
|
|
@@ -627,7 +763,9 @@ type LeadCondition = {
|
|
|
627
763
|
* Do not edit manually.
|
|
628
764
|
* ARPC — Achieve Resolution Partner Connect API
|
|
629
765
|
* 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.
|
|
630
|
-
|
|
766
|
+
|
|
767
|
+
**Published:** 2026-08-08
|
|
768
|
+
* OpenAPI spec version: 2026.16.0
|
|
631
769
|
*/
|
|
632
770
|
|
|
633
771
|
/**
|
|
@@ -705,7 +843,9 @@ interface DebtAccount {
|
|
|
705
843
|
* Do not edit manually.
|
|
706
844
|
* ARPC — Achieve Resolution Partner Connect API
|
|
707
845
|
* 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.
|
|
708
|
-
|
|
846
|
+
|
|
847
|
+
**Published:** 2026-08-08
|
|
848
|
+
* OpenAPI spec version: 2026.16.0
|
|
709
849
|
*/
|
|
710
850
|
|
|
711
851
|
/**
|
|
@@ -807,12 +947,12 @@ interface CreateLeadRequest {
|
|
|
807
947
|
transportation_expenses?: number;
|
|
808
948
|
/** Other miscellaneous monthly expenses (USD) */
|
|
809
949
|
other_expenses_describe?: number;
|
|
810
|
-
/** Primary hardship category
|
|
811
|
-
hardship_category?:
|
|
950
|
+
/** Primary hardship category */
|
|
951
|
+
hardship_category?: CreateLeadRequestHardshipCategory;
|
|
812
952
|
/** Free-text description when hardship category is 'other' */
|
|
813
953
|
hardship_category_other?: string;
|
|
814
|
-
/** Primary goal category
|
|
815
|
-
goal_category?:
|
|
954
|
+
/** Primary goal category */
|
|
955
|
+
goal_category?: CreateLeadRequestGoalCategory;
|
|
816
956
|
/** Free-text description when goal category is 'other' */
|
|
817
957
|
goal_category_other?: string;
|
|
818
958
|
/** Next paycheck date (YYYY-MM-DD) */
|
|
@@ -851,17 +991,88 @@ interface CreateLeadRequest {
|
|
|
851
991
|
* Do not edit manually.
|
|
852
992
|
* ARPC — Achieve Resolution Partner Connect API
|
|
853
993
|
* 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.
|
|
854
|
-
|
|
994
|
+
|
|
995
|
+
**Published:** 2026-08-08
|
|
996
|
+
* OpenAPI spec version: 2026.16.0
|
|
997
|
+
*/
|
|
998
|
+
/**
|
|
999
|
+
* Current program / opportunity stage
|
|
1000
|
+
*/
|
|
1001
|
+
type LeadApplicationStatus = typeof LeadApplicationStatus[keyof typeof LeadApplicationStatus];
|
|
1002
|
+
declare const LeadApplicationStatus: {
|
|
1003
|
+
readonly Attempting_Contact: "Attempting Contact";
|
|
1004
|
+
readonly Contacted: "Contacted";
|
|
1005
|
+
readonly Waiting_for_Statements: "Waiting for Statements";
|
|
1006
|
+
readonly Submit_to_UW: "Submit to UW";
|
|
1007
|
+
readonly UW_Processing: "UW Processing";
|
|
1008
|
+
readonly Waiting_for_Agreement: "Waiting for Agreement";
|
|
1009
|
+
readonly Agreement_Review: "Agreement Review";
|
|
1010
|
+
readonly Welcome_Call_Pending: "Welcome Call Pending";
|
|
1011
|
+
readonly Attorney_Review: "Attorney Review";
|
|
1012
|
+
readonly Pending_Enrollment: "Pending Enrollment";
|
|
1013
|
+
readonly Enrolled_Client: "Enrolled Client";
|
|
1014
|
+
};
|
|
1015
|
+
|
|
1016
|
+
/**
|
|
1017
|
+
* Generated by orval v7.21.0 🍺
|
|
1018
|
+
* Do not edit manually.
|
|
1019
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1020
|
+
* 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.
|
|
1021
|
+
|
|
1022
|
+
**Published:** 2026-08-08
|
|
1023
|
+
* OpenAPI spec version: 2026.16.0
|
|
1024
|
+
*/
|
|
1025
|
+
/**
|
|
1026
|
+
* Client's preferred language
|
|
1027
|
+
*/
|
|
1028
|
+
type LeadApplicationLanguage = typeof LeadApplicationLanguage[keyof typeof LeadApplicationLanguage];
|
|
1029
|
+
declare const LeadApplicationLanguage: {
|
|
1030
|
+
readonly English: "English";
|
|
1031
|
+
readonly Spanish: "Spanish";
|
|
1032
|
+
};
|
|
1033
|
+
|
|
1034
|
+
/**
|
|
1035
|
+
* Generated by orval v7.21.0 🍺
|
|
1036
|
+
* Do not edit manually.
|
|
1037
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1038
|
+
* 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.
|
|
1039
|
+
|
|
1040
|
+
**Published:** 2026-08-08
|
|
1041
|
+
* OpenAPI spec version: 2026.16.0
|
|
1042
|
+
*/
|
|
1043
|
+
/**
|
|
1044
|
+
* Bankruptcy status on file
|
|
1045
|
+
*/
|
|
1046
|
+
type LeadApplicantBankruptcy = typeof LeadApplicantBankruptcy[keyof typeof LeadApplicantBankruptcy];
|
|
1047
|
+
declare const LeadApplicantBankruptcy: {
|
|
1048
|
+
readonly No: "No";
|
|
1049
|
+
readonly Chapter_7: "Chapter 7";
|
|
1050
|
+
readonly Chapter_11: "Chapter 11";
|
|
1051
|
+
readonly Chapter_12: "Chapter 12";
|
|
1052
|
+
readonly Chapter_13: "Chapter 13";
|
|
1053
|
+
};
|
|
1054
|
+
|
|
1055
|
+
/**
|
|
1056
|
+
* Generated by orval v7.21.0 🍺
|
|
1057
|
+
* Do not edit manually.
|
|
1058
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1059
|
+
* 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.
|
|
1060
|
+
|
|
1061
|
+
**Published:** 2026-08-08
|
|
1062
|
+
* OpenAPI spec version: 2026.16.0
|
|
855
1063
|
*/
|
|
856
1064
|
/**
|
|
857
1065
|
* Pay frequency
|
|
858
1066
|
*/
|
|
859
1067
|
type LeadApplicantPayFrequency = typeof LeadApplicantPayFrequency[keyof typeof LeadApplicantPayFrequency];
|
|
860
1068
|
declare const LeadApplicantPayFrequency: {
|
|
1069
|
+
readonly none: "none";
|
|
861
1070
|
readonly weekly: "weekly";
|
|
862
1071
|
readonly 'bi-weekly': "bi-weekly";
|
|
863
|
-
readonly
|
|
864
|
-
readonly
|
|
1072
|
+
readonly split: "split";
|
|
1073
|
+
readonly regular: "regular";
|
|
1074
|
+
readonly irregular: "irregular";
|
|
1075
|
+
readonly unknown: "unknown";
|
|
865
1076
|
};
|
|
866
1077
|
|
|
867
1078
|
/**
|
|
@@ -869,7 +1080,9 @@ declare const LeadApplicantPayFrequency: {
|
|
|
869
1080
|
* Do not edit manually.
|
|
870
1081
|
* ARPC — Achieve Resolution Partner Connect API
|
|
871
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.
|
|
872
|
-
|
|
1083
|
+
|
|
1084
|
+
**Published:** 2026-08-08
|
|
1085
|
+
* OpenAPI spec version: 2026.16.0
|
|
873
1086
|
*/
|
|
874
1087
|
/**
|
|
875
1088
|
* Current employment status
|
|
@@ -879,7 +1092,7 @@ declare const LeadApplicantEmploymentStatus: {
|
|
|
879
1092
|
readonly 'Full-Time': "Full-Time";
|
|
880
1093
|
readonly 'Part-Time': "Part-Time";
|
|
881
1094
|
readonly 'Self-Employed': "Self-Employed";
|
|
882
|
-
readonly
|
|
1095
|
+
readonly Not_Employed: "Not Employed";
|
|
883
1096
|
readonly Retired: "Retired";
|
|
884
1097
|
readonly Other: "Other";
|
|
885
1098
|
};
|
|
@@ -889,7 +1102,9 @@ declare const LeadApplicantEmploymentStatus: {
|
|
|
889
1102
|
* Do not edit manually.
|
|
890
1103
|
* ARPC — Achieve Resolution Partner Connect API
|
|
891
1104
|
* 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.
|
|
892
|
-
|
|
1105
|
+
|
|
1106
|
+
**Published:** 2026-08-08
|
|
1107
|
+
* OpenAPI spec version: 2026.16.0
|
|
893
1108
|
*/
|
|
894
1109
|
|
|
895
1110
|
/**
|
|
@@ -912,7 +1127,7 @@ type LeadApplicant = {
|
|
|
912
1127
|
/** Monthly unemployment income (USD) */
|
|
913
1128
|
unemployment?: number;
|
|
914
1129
|
/** Bankruptcy status on file */
|
|
915
|
-
bankruptcy?:
|
|
1130
|
+
bankruptcy?: LeadApplicantBankruptcy;
|
|
916
1131
|
/**
|
|
917
1132
|
* Conditions associated with this applicant
|
|
918
1133
|
* @nullable
|
|
@@ -988,7 +1203,79 @@ type LeadApplicant = {
|
|
|
988
1203
|
* Do not edit manually.
|
|
989
1204
|
* ARPC — Achieve Resolution Partner Connect API
|
|
990
1205
|
* 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.
|
|
991
|
-
|
|
1206
|
+
|
|
1207
|
+
**Published:** 2026-08-08
|
|
1208
|
+
* OpenAPI spec version: 2026.16.0
|
|
1209
|
+
*/
|
|
1210
|
+
/**
|
|
1211
|
+
* Sub-status of the current stage
|
|
1212
|
+
*/
|
|
1213
|
+
type LeadApplicationSubStatus = typeof LeadApplicationSubStatus[keyof typeof LeadApplicationSubStatus];
|
|
1214
|
+
declare const LeadApplicationSubStatus: {
|
|
1215
|
+
readonly UW_Approved: "UW Approved";
|
|
1216
|
+
readonly UW_Conditional_Approval: "UW Conditional Approval";
|
|
1217
|
+
readonly Agreement_Not_Generated: "Agreement Not Generated";
|
|
1218
|
+
readonly View_Only_Agreement_Sent: "View Only Agreement Sent";
|
|
1219
|
+
readonly Agreement_Acknowledgement_Sent: "Agreement Acknowledgement Sent";
|
|
1220
|
+
readonly Agreement_Acknowledgement_Received: "Agreement Acknowledgement Received";
|
|
1221
|
+
readonly Agreement_Acknowledgement_Pending: "Agreement Acknowledgement Pending";
|
|
1222
|
+
readonly Agreement_Generated: "Agreement Generated";
|
|
1223
|
+
readonly 'Agreement_Sent_-_Signature_Pending': "Agreement Sent - Signature Pending";
|
|
1224
|
+
readonly Agreement_Not_Sent: "Agreement Not Sent";
|
|
1225
|
+
readonly Agreement_Voided: "Agreement Voided";
|
|
1226
|
+
readonly Client_Declined_Agreement: "Client Declined Agreement";
|
|
1227
|
+
readonly Agreement_Update_Required: "Agreement Update Required";
|
|
1228
|
+
readonly Agreement_Received: "Agreement Received";
|
|
1229
|
+
readonly Welcome_Call_Ready: "Welcome Call Ready";
|
|
1230
|
+
readonly Welcome_Call_Complete: "Welcome Call Complete";
|
|
1231
|
+
readonly Not_Interested: "Not Interested";
|
|
1232
|
+
readonly Low_Debt: "Low Debt";
|
|
1233
|
+
readonly Bad_State: "Bad State";
|
|
1234
|
+
readonly Pushed_to_CS_SalesForce: "Pushed to CS SalesForce";
|
|
1235
|
+
readonly Request_Additional_Info: "Request Additional Info";
|
|
1236
|
+
readonly Resubmit_to_UW: "Resubmit to UW";
|
|
1237
|
+
readonly Assign_to_UW: "Assign to UW";
|
|
1238
|
+
readonly Assigned_to_UW: "Assigned to UW";
|
|
1239
|
+
readonly Leader_Review: "Leader Review";
|
|
1240
|
+
readonly Resubmit_to_Welcome_Call: "Resubmit to Welcome Call";
|
|
1241
|
+
readonly Pending_Documents: "Pending Documents";
|
|
1242
|
+
readonly Resubmit_to_Agreement_Review: "Resubmit to Agreement Review";
|
|
1243
|
+
readonly Aborted: "Aborted";
|
|
1244
|
+
readonly Client_Termination: "Client Termination";
|
|
1245
|
+
readonly Pending_Enrollment: "Pending Enrollment";
|
|
1246
|
+
readonly UW_Review_Required: "UW Review Required";
|
|
1247
|
+
readonly DNC: "DNC";
|
|
1248
|
+
readonly Resubmit_for_Enrollment: "Resubmit for Enrollment";
|
|
1249
|
+
readonly Unable_to_contact: "Unable to contact";
|
|
1250
|
+
readonly Partner_Transfer: "Partner Transfer";
|
|
1251
|
+
readonly Internal_Transfer: "Internal Transfer";
|
|
1252
|
+
readonly Program_Review_Complete: "Program Review Complete";
|
|
1253
|
+
readonly Sending_for_Attorney_Review: "Sending for Attorney Review";
|
|
1254
|
+
readonly Unable_to_Send_for_Attorney_Review: "Unable to Send for Attorney Review";
|
|
1255
|
+
readonly Attorney_Routing_Failed: "Attorney Routing Failed";
|
|
1256
|
+
readonly Sent_for_Attorney_Review: "Sent for Attorney Review";
|
|
1257
|
+
readonly Received_by_Law_Firm: "Received by Law Firm";
|
|
1258
|
+
readonly Attorney_Unable_to_Contact: "Attorney Unable to Contact";
|
|
1259
|
+
readonly Resubmit_to_Attorney_Review: "Resubmit to Attorney Review";
|
|
1260
|
+
readonly Attorney_Review_Update: "Attorney Review Update";
|
|
1261
|
+
readonly Attorney_Agreement_Signed: "Attorney Agreement Signed";
|
|
1262
|
+
readonly Attorney_Rejection: "Attorney Rejection";
|
|
1263
|
+
readonly Attorney_Law_Firm_Enrolled: "Attorney Law Firm Enrolled";
|
|
1264
|
+
readonly Program_Review_Ready: "Program Review Ready";
|
|
1265
|
+
readonly Agreement_Paused: "Agreement Paused";
|
|
1266
|
+
readonly 'Attorney_Call-Back_Scheduled': "Attorney Call-Back Scheduled";
|
|
1267
|
+
readonly Request_for_Change: "Request for Change";
|
|
1268
|
+
readonly Appointment_Missed: "Appointment Missed";
|
|
1269
|
+
};
|
|
1270
|
+
|
|
1271
|
+
/**
|
|
1272
|
+
* Generated by orval v7.21.0 🍺
|
|
1273
|
+
* Do not edit manually.
|
|
1274
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1275
|
+
* 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.
|
|
1276
|
+
|
|
1277
|
+
**Published:** 2026-08-08
|
|
1278
|
+
* OpenAPI spec version: 2026.16.0
|
|
992
1279
|
*/
|
|
993
1280
|
/**
|
|
994
1281
|
* Indicates whether the program is FDR or CSS serviced
|
|
@@ -1004,7 +1291,30 @@ declare const LeadApplicationFdrOrCss: {
|
|
|
1004
1291
|
* Do not edit manually.
|
|
1005
1292
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1006
1293
|
* 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.
|
|
1007
|
-
|
|
1294
|
+
|
|
1295
|
+
**Published:** 2026-08-08
|
|
1296
|
+
* OpenAPI spec version: 2026.16.0
|
|
1297
|
+
*/
|
|
1298
|
+
/**
|
|
1299
|
+
* Draft frequency type, as reported by the lead.
|
|
1300
|
+
|
|
1301
|
+
⚠️ Patched locally by `openapi/repairs.ts` — this differs from FDR's published spec.
|
|
1302
|
+
*/
|
|
1303
|
+
type LeadApplicationDraftType = typeof LeadApplicationDraftType[keyof typeof LeadApplicationDraftType];
|
|
1304
|
+
declare const LeadApplicationDraftType: {
|
|
1305
|
+
readonly 'Bi-Weekly': "Bi-Weekly";
|
|
1306
|
+
readonly Regular: "Regular";
|
|
1307
|
+
readonly Split: "Split";
|
|
1308
|
+
};
|
|
1309
|
+
|
|
1310
|
+
/**
|
|
1311
|
+
* Generated by orval v7.21.0 🍺
|
|
1312
|
+
* Do not edit manually.
|
|
1313
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1314
|
+
* 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.
|
|
1315
|
+
|
|
1316
|
+
**Published:** 2026-08-08
|
|
1317
|
+
* OpenAPI spec version: 2026.16.0
|
|
1008
1318
|
*/
|
|
1009
1319
|
/**
|
|
1010
1320
|
* Whether client is on fixed income. Salesforce returns this as the string \"Yes\" or \"No\" (not a boolean).
|
|
@@ -1020,7 +1330,9 @@ declare const LeadApplicationFixedIncome: {
|
|
|
1020
1330
|
* Do not edit manually.
|
|
1021
1331
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1022
1332
|
* 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.
|
|
1023
|
-
|
|
1333
|
+
|
|
1334
|
+
**Published:** 2026-08-08
|
|
1335
|
+
* OpenAPI spec version: 2026.16.0
|
|
1024
1336
|
*/
|
|
1025
1337
|
/**
|
|
1026
1338
|
* Whether the client owns or rents their home
|
|
@@ -1036,7 +1348,75 @@ declare const LeadApplicationOwnOrRent: {
|
|
|
1036
1348
|
* Do not edit manually.
|
|
1037
1349
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1038
1350
|
* 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.
|
|
1039
|
-
|
|
1351
|
+
|
|
1352
|
+
**Published:** 2026-08-08
|
|
1353
|
+
* OpenAPI spec version: 2026.16.0
|
|
1354
|
+
*/
|
|
1355
|
+
/**
|
|
1356
|
+
* Primary hardship category
|
|
1357
|
+
*/
|
|
1358
|
+
type LeadApplicationHardshipCategory = typeof LeadApplicationHardshipCategory[keyof typeof LeadApplicationHardshipCategory];
|
|
1359
|
+
declare const LeadApplicationHardshipCategory: {
|
|
1360
|
+
readonly Job_Loss: "Job Loss";
|
|
1361
|
+
readonly Reduced_Income: "Reduced Income";
|
|
1362
|
+
readonly Medical: "Medical";
|
|
1363
|
+
readonly Divorce: "Divorce";
|
|
1364
|
+
readonly Unexpected_Expenses: "Unexpected Expenses";
|
|
1365
|
+
readonly Other: "Other";
|
|
1366
|
+
};
|
|
1367
|
+
|
|
1368
|
+
/**
|
|
1369
|
+
* Generated by orval v7.21.0 🍺
|
|
1370
|
+
* Do not edit manually.
|
|
1371
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1372
|
+
* 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.
|
|
1373
|
+
|
|
1374
|
+
**Published:** 2026-08-08
|
|
1375
|
+
* OpenAPI spec version: 2026.16.0
|
|
1376
|
+
*/
|
|
1377
|
+
/**
|
|
1378
|
+
* Client's primary financial goal category
|
|
1379
|
+
*/
|
|
1380
|
+
type LeadApplicationGoalCategory = typeof LeadApplicationGoalCategory[keyof typeof LeadApplicationGoalCategory];
|
|
1381
|
+
declare const LeadApplicationGoalCategory: {
|
|
1382
|
+
readonly Avoid_Bankruptcy: "Avoid Bankruptcy";
|
|
1383
|
+
readonly Get_out_of_Debt: "Get out of Debt";
|
|
1384
|
+
readonly 'Build_personal_wealth,_savings': "Build personal wealth, savings";
|
|
1385
|
+
readonly Relieve_pressure_of_monthly_bills: "Relieve pressure of monthly bills";
|
|
1386
|
+
};
|
|
1387
|
+
|
|
1388
|
+
/**
|
|
1389
|
+
* Generated by orval v7.21.0 🍺
|
|
1390
|
+
* Do not edit manually.
|
|
1391
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1392
|
+
* 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.
|
|
1393
|
+
|
|
1394
|
+
**Published:** 2026-08-08
|
|
1395
|
+
* OpenAPI spec version: 2026.16.0
|
|
1396
|
+
*/
|
|
1397
|
+
/**
|
|
1398
|
+
* Client's secondary financial goal
|
|
1399
|
+
*/
|
|
1400
|
+
type LeadApplicationSecondaryGoal = typeof LeadApplicationSecondaryGoal[keyof typeof LeadApplicationSecondaryGoal];
|
|
1401
|
+
declare const LeadApplicationSecondaryGoal: {
|
|
1402
|
+
readonly Purchase_a_home: "Purchase a home";
|
|
1403
|
+
readonly 'Major_purchase_(eg_car,_vacation,_home_improvement,_etc)': "Major purchase (e.g. car, vacation, home improvement, etc)";
|
|
1404
|
+
readonly Improve_Credit_Score: "Improve Credit Score";
|
|
1405
|
+
readonly Retirement: "Retirement";
|
|
1406
|
+
readonly Get_married: "Get married";
|
|
1407
|
+
readonly 'Pay_for_children\'s_college': "Pay for children's college";
|
|
1408
|
+
readonly Help_family: "Help family";
|
|
1409
|
+
readonly Other: "Other";
|
|
1410
|
+
};
|
|
1411
|
+
|
|
1412
|
+
/**
|
|
1413
|
+
* Generated by orval v7.21.0 🍺
|
|
1414
|
+
* Do not edit manually.
|
|
1415
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1416
|
+
* 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.
|
|
1417
|
+
|
|
1418
|
+
**Published:** 2026-08-08
|
|
1419
|
+
* OpenAPI spec version: 2026.16.0
|
|
1040
1420
|
*/
|
|
1041
1421
|
/**
|
|
1042
1422
|
* Source of the credit report pull (also present inside applicant)
|
|
@@ -1052,7 +1432,9 @@ declare const LeadApplicationCreditPullSource: {
|
|
|
1052
1432
|
* Do not edit manually.
|
|
1053
1433
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1054
1434
|
* 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.
|
|
1055
|
-
|
|
1435
|
+
|
|
1436
|
+
**Published:** 2026-08-08
|
|
1437
|
+
* OpenAPI spec version: 2026.16.0
|
|
1056
1438
|
*/
|
|
1057
1439
|
/**
|
|
1058
1440
|
* Creditor or original creditor details
|
|
@@ -1089,7 +1471,9 @@ interface LeadCreditor {
|
|
|
1089
1471
|
* Do not edit manually.
|
|
1090
1472
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1091
1473
|
* 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.
|
|
1092
|
-
|
|
1474
|
+
|
|
1475
|
+
**Published:** 2026-08-08
|
|
1476
|
+
* OpenAPI spec version: 2026.16.0
|
|
1093
1477
|
*/
|
|
1094
1478
|
/**
|
|
1095
1479
|
* Responsibility type for the account
|
|
@@ -1099,6 +1483,13 @@ declare const LeadDebtAccountResponsibility: {
|
|
|
1099
1483
|
readonly individual: "individual";
|
|
1100
1484
|
readonly joint: "joint";
|
|
1101
1485
|
readonly 'authorized-user': "authorized-user";
|
|
1486
|
+
readonly 'co-signer': "co-signer";
|
|
1487
|
+
readonly business: "business";
|
|
1488
|
+
readonly 'on-behalf-of': "on-behalf-of";
|
|
1489
|
+
readonly signer: "signer";
|
|
1490
|
+
readonly deceased: "deceased";
|
|
1491
|
+
readonly terminated: "terminated";
|
|
1492
|
+
readonly undesignated: "undesignated";
|
|
1102
1493
|
};
|
|
1103
1494
|
|
|
1104
1495
|
/**
|
|
@@ -1106,7 +1497,9 @@ declare const LeadDebtAccountResponsibility: {
|
|
|
1106
1497
|
* Do not edit manually.
|
|
1107
1498
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1108
1499
|
* 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.
|
|
1109
|
-
|
|
1500
|
+
|
|
1501
|
+
**Published:** 2026-08-08
|
|
1502
|
+
* OpenAPI spec version: 2026.16.0
|
|
1110
1503
|
*/
|
|
1111
1504
|
/**
|
|
1112
1505
|
* Ownership of the account
|
|
@@ -1123,15 +1516,114 @@ declare const LeadDebtAccountOwnership: {
|
|
|
1123
1516
|
* Do not edit manually.
|
|
1124
1517
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1125
1518
|
* 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.
|
|
1126
|
-
|
|
1519
|
+
|
|
1520
|
+
**Published:** 2026-08-08
|
|
1521
|
+
* OpenAPI spec version: 2026.16.0
|
|
1522
|
+
*/
|
|
1523
|
+
/**
|
|
1524
|
+
* Source of the debt account record
|
|
1525
|
+
*/
|
|
1526
|
+
type LeadDebtAccountSource = typeof LeadDebtAccountSource[keyof typeof LeadDebtAccountSource];
|
|
1527
|
+
declare const LeadDebtAccountSource: {
|
|
1528
|
+
readonly cbr: "cbr";
|
|
1529
|
+
readonly 'added-by-client': "added-by-client";
|
|
1530
|
+
readonly 'cbr-modified-by-client': "cbr-modified-by-client";
|
|
1531
|
+
readonly 'cbr-removed-by-client': "cbr-removed-by-client";
|
|
1532
|
+
readonly 'added-by-dc': "added-by-dc";
|
|
1533
|
+
};
|
|
1534
|
+
|
|
1535
|
+
/**
|
|
1536
|
+
* Generated by orval v7.21.0 🍺
|
|
1537
|
+
* Do not edit manually.
|
|
1538
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1539
|
+
* 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.
|
|
1540
|
+
|
|
1541
|
+
**Published:** 2026-08-08
|
|
1542
|
+
* OpenAPI spec version: 2026.16.0
|
|
1127
1543
|
*/
|
|
1544
|
+
/**
|
|
1545
|
+
* Type of account
|
|
1546
|
+
*/
|
|
1547
|
+
type LeadDebtAccountAccountType = typeof LeadDebtAccountAccountType[keyof typeof LeadDebtAccountAccountType];
|
|
1548
|
+
declare const LeadDebtAccountAccountType: {
|
|
1549
|
+
readonly 'credit-card': "credit-card";
|
|
1550
|
+
readonly 'unsecured-loan': "unsecured-loan";
|
|
1551
|
+
readonly 'secured-debt': "secured-debt";
|
|
1552
|
+
readonly mortgage: "mortgage";
|
|
1553
|
+
readonly 'line-of-credit': "line-of-credit";
|
|
1554
|
+
readonly collections: "collections";
|
|
1555
|
+
readonly medical: "medical";
|
|
1556
|
+
readonly auto: "auto";
|
|
1557
|
+
readonly 'education-loan': "education-loan";
|
|
1558
|
+
readonly 'secured-credit-card': "secured-credit-card";
|
|
1559
|
+
readonly 'credit-union': "credit-union";
|
|
1560
|
+
readonly 'federal-credit-union': "federal-credit-union";
|
|
1561
|
+
readonly 'with-law-firm': "with-law-firm";
|
|
1562
|
+
readonly 'old-judgement': "old-judgement";
|
|
1563
|
+
readonly 'discontinued-service': "discontinued-service";
|
|
1564
|
+
readonly 'business-debt-other': "business-debt-other";
|
|
1565
|
+
readonly 'business-debt-credit-card': "business-debt-credit-card";
|
|
1566
|
+
readonly 'business-debt-loan': "business-debt-loan";
|
|
1567
|
+
readonly 'government-debt': "government-debt";
|
|
1568
|
+
readonly 'legal-fees': "legal-fees";
|
|
1569
|
+
};
|
|
1570
|
+
|
|
1571
|
+
/**
|
|
1572
|
+
* Generated by orval v7.21.0 🍺
|
|
1573
|
+
* Do not edit manually.
|
|
1574
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1575
|
+
* 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.
|
|
1576
|
+
|
|
1577
|
+
**Published:** 2026-08-08
|
|
1578
|
+
* OpenAPI spec version: 2026.16.0
|
|
1579
|
+
*/
|
|
1580
|
+
/**
|
|
1581
|
+
* Ineligibility reason identifier (PS_Id__c from PS_Evaluations_Config__mdt). See PgIneligibleReasonId for the full set of known values.
|
|
1582
|
+
*/
|
|
1583
|
+
type IneligibleReasonReasonId = typeof IneligibleReasonReasonId[keyof typeof IneligibleReasonReasonId];
|
|
1584
|
+
declare const IneligibleReasonReasonId: {
|
|
1585
|
+
readonly 'account-debt-too-low': "account-debt-too-low";
|
|
1586
|
+
readonly 'ca-ab1405-joint-debt-3rd-party': "ca-ab1405-joint-debt-3rd-party";
|
|
1587
|
+
readonly 'conflict-of-interest-ffam-cplus-balance': "conflict-of-interest-ffam-cplus-balance";
|
|
1588
|
+
readonly 'conflict-of-interest-ffam-fplus-balance': "conflict-of-interest-ffam-fplus-balance";
|
|
1589
|
+
readonly 'credit-union-cross-collateral': "credit-union-cross-collateral";
|
|
1590
|
+
readonly 'debt-too-low': "debt-too-low";
|
|
1591
|
+
readonly 'duplicate-account': "duplicate-account";
|
|
1592
|
+
readonly 'ineligible-applicants': "ineligible-applicants";
|
|
1593
|
+
readonly 'invalid-balance-date': "invalid-balance-date";
|
|
1594
|
+
readonly 'invalid-balance-date-percent-exceeded': "invalid-balance-date-percent-exceeded";
|
|
1595
|
+
readonly 'merchandise-account-too-new': "merchandise-account-too-new";
|
|
1596
|
+
readonly 'secured-loan': "secured-loan";
|
|
1597
|
+
readonly 'single-creditor-collection-debt-percent-exceeded': "single-creditor-collection-debt-percent-exceeded";
|
|
1598
|
+
readonly 'unacceptable-creditor': "unacceptable-creditor";
|
|
1599
|
+
readonly 'unacceptable-education': "unacceptable-education";
|
|
1600
|
+
readonly 'unacceptable-equipment': "unacceptable-equipment";
|
|
1601
|
+
readonly 'unacceptable-government': "unacceptable-government";
|
|
1602
|
+
readonly 'unacceptable-insurance': "unacceptable-insurance";
|
|
1603
|
+
readonly 'unacceptable-legal-fees': "unacceptable-legal-fees";
|
|
1604
|
+
readonly 'unacceptable-mortgage': "unacceptable-mortgage";
|
|
1605
|
+
readonly 'unacceptable-responsibility': "unacceptable-responsibility";
|
|
1606
|
+
readonly 'unacceptable-secured': "unacceptable-secured";
|
|
1607
|
+
readonly 'unacceptable-state': "unacceptable-state";
|
|
1608
|
+
};
|
|
1609
|
+
|
|
1610
|
+
/**
|
|
1611
|
+
* Generated by orval v7.21.0 🍺
|
|
1612
|
+
* Do not edit manually.
|
|
1613
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1614
|
+
* 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.
|
|
1615
|
+
|
|
1616
|
+
**Published:** 2026-08-08
|
|
1617
|
+
* OpenAPI spec version: 2026.16.0
|
|
1618
|
+
*/
|
|
1619
|
+
|
|
1128
1620
|
/**
|
|
1129
1621
|
* Ineligibility reason code wrapper
|
|
1130
1622
|
* @nullable
|
|
1131
1623
|
*/
|
|
1132
1624
|
type IneligibleReason = {
|
|
1133
|
-
/** Ineligibility reason identifier */
|
|
1134
|
-
reason_id?:
|
|
1625
|
+
/** Ineligibility reason identifier (PS_Id__c from PS_Evaluations_Config__mdt). See PgIneligibleReasonId for the full set of known values. */
|
|
1626
|
+
reason_id?: IneligibleReasonReasonId;
|
|
1135
1627
|
} | null;
|
|
1136
1628
|
|
|
1137
1629
|
/**
|
|
@@ -1139,7 +1631,9 @@ type IneligibleReason = {
|
|
|
1139
1631
|
* Do not edit manually.
|
|
1140
1632
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1141
1633
|
* 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.
|
|
1142
|
-
|
|
1634
|
+
|
|
1635
|
+
**Published:** 2026-08-08
|
|
1636
|
+
* OpenAPI spec version: 2026.16.0
|
|
1143
1637
|
*/
|
|
1144
1638
|
|
|
1145
1639
|
/**
|
|
@@ -1160,7 +1654,7 @@ interface LeadDebtAccount {
|
|
|
1160
1654
|
/** Ownership of the account */
|
|
1161
1655
|
ownership?: LeadDebtAccountOwnership;
|
|
1162
1656
|
/** Source of the debt account record */
|
|
1163
|
-
source?:
|
|
1657
|
+
source?: LeadDebtAccountSource;
|
|
1164
1658
|
/** Age / delinquency bucket of the debt */
|
|
1165
1659
|
aging?: string;
|
|
1166
1660
|
/** Rank assigned by DebtAccountRankingUtil (lower = higher priority) */
|
|
@@ -1199,7 +1693,7 @@ interface LeadDebtAccount {
|
|
|
1199
1693
|
/** Whether the account is active */
|
|
1200
1694
|
is_active?: string;
|
|
1201
1695
|
/** Type of account */
|
|
1202
|
-
account_type?:
|
|
1696
|
+
account_type?: LeadDebtAccountAccountType;
|
|
1203
1697
|
/** Sub-type of the account */
|
|
1204
1698
|
sub_account_type?: string;
|
|
1205
1699
|
/** Condition of the account */
|
|
@@ -1234,6 +1728,16 @@ interface LeadDebtAccount {
|
|
|
1234
1728
|
credit_utilization?: string;
|
|
1235
1729
|
/** Most recent delinquency bucket reported */
|
|
1236
1730
|
most_recent_delinquency?: string;
|
|
1731
|
+
/**
|
|
1732
|
+
* Credit bureau that reported this tradeline
|
|
1733
|
+
* @nullable
|
|
1734
|
+
*/
|
|
1735
|
+
tradeline_source?: string | null;
|
|
1736
|
+
/**
|
|
1737
|
+
* Universal identifier for the tradeline across credit bureaus
|
|
1738
|
+
* @nullable
|
|
1739
|
+
*/
|
|
1740
|
+
universal_id?: string | null;
|
|
1237
1741
|
/** First name of the joint account holder, if applicable */
|
|
1238
1742
|
joint_holder_first_name?: string;
|
|
1239
1743
|
/** Last name of the joint account holder, if applicable */
|
|
@@ -1258,19 +1762,136 @@ interface LeadDebtAccount {
|
|
|
1258
1762
|
* Do not edit manually.
|
|
1259
1763
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1260
1764
|
* 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.
|
|
1261
|
-
|
|
1765
|
+
|
|
1766
|
+
**Published:** 2026-08-08
|
|
1767
|
+
* OpenAPI spec version: 2026.16.0
|
|
1768
|
+
*/
|
|
1769
|
+
/**
|
|
1770
|
+
* Tier label for this payment option
|
|
1771
|
+
* @nullable
|
|
1772
|
+
*/
|
|
1773
|
+
type PaymentOptionEvaluationType = typeof PaymentOptionEvaluationType[keyof typeof PaymentOptionEvaluationType] | null;
|
|
1774
|
+
declare const PaymentOptionEvaluationType: {
|
|
1775
|
+
readonly Most_Affordable: "Most Affordable";
|
|
1776
|
+
readonly Best_Value: "Best Value";
|
|
1777
|
+
readonly Fastest: "Fastest";
|
|
1778
|
+
};
|
|
1779
|
+
|
|
1780
|
+
/**
|
|
1781
|
+
* Generated by orval v7.21.0 🍺
|
|
1782
|
+
* Do not edit manually.
|
|
1783
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1784
|
+
* 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.
|
|
1785
|
+
|
|
1786
|
+
**Published:** 2026-08-08
|
|
1787
|
+
* OpenAPI spec version: 2026.16.0
|
|
1788
|
+
*/
|
|
1789
|
+
|
|
1790
|
+
/**
|
|
1791
|
+
* A single selectable payment option
|
|
1792
|
+
* @nullable
|
|
1793
|
+
*/
|
|
1794
|
+
type PaymentOption = {
|
|
1795
|
+
/** Monthly deposit amount for this option (USD) */
|
|
1796
|
+
monthly_deposit?: number;
|
|
1797
|
+
/** Total program cost for this option (USD) */
|
|
1798
|
+
program_cost?: number;
|
|
1799
|
+
/** Program length for this option (months) */
|
|
1800
|
+
program_length?: number;
|
|
1801
|
+
/**
|
|
1802
|
+
* Tier label for this payment option
|
|
1803
|
+
* @nullable
|
|
1804
|
+
*/
|
|
1805
|
+
evaluation_type?: PaymentOptionEvaluationType;
|
|
1806
|
+
} | null;
|
|
1807
|
+
|
|
1808
|
+
/**
|
|
1809
|
+
* Generated by orval v7.21.0 🍺
|
|
1810
|
+
* Do not edit manually.
|
|
1811
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1812
|
+
* 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.
|
|
1813
|
+
|
|
1814
|
+
**Published:** 2026-08-08
|
|
1815
|
+
* OpenAPI spec version: 2026.16.0
|
|
1816
|
+
*/
|
|
1817
|
+
/**
|
|
1818
|
+
* Draft frequency type
|
|
1819
|
+
*/
|
|
1820
|
+
type PaymentScheduleDraftType = typeof PaymentScheduleDraftType[keyof typeof PaymentScheduleDraftType];
|
|
1821
|
+
declare const PaymentScheduleDraftType: {
|
|
1822
|
+
readonly regular: "regular";
|
|
1823
|
+
readonly split: "split";
|
|
1824
|
+
readonly 'bi-weekly': "bi-weekly";
|
|
1825
|
+
};
|
|
1826
|
+
|
|
1827
|
+
/**
|
|
1828
|
+
* Generated by orval v7.21.0 🍺
|
|
1829
|
+
* Do not edit manually.
|
|
1830
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1831
|
+
* 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.
|
|
1832
|
+
|
|
1833
|
+
**Published:** 2026-08-08
|
|
1834
|
+
* OpenAPI spec version: 2026.16.0
|
|
1835
|
+
*/
|
|
1836
|
+
|
|
1837
|
+
/**
|
|
1838
|
+
* A single draft-frequency schedule within a payment schedule option
|
|
1839
|
+
*/
|
|
1840
|
+
interface PaymentSchedule {
|
|
1841
|
+
/** Schedule identifier */
|
|
1842
|
+
id?: string;
|
|
1843
|
+
/** Draft frequency type */
|
|
1844
|
+
draft_type?: PaymentScheduleDraftType;
|
|
1845
|
+
/** Draft deposit amount for this schedule (USD) */
|
|
1846
|
+
draft_deposit?: number;
|
|
1847
|
+
/** Effective monthly payment amount regardless of draft frequency (USD) */
|
|
1848
|
+
estimated_monthly_payment?: number;
|
|
1849
|
+
}
|
|
1850
|
+
|
|
1851
|
+
/**
|
|
1852
|
+
* Generated by orval v7.21.0 🍺
|
|
1853
|
+
* Do not edit manually.
|
|
1854
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1855
|
+
* 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.
|
|
1856
|
+
|
|
1857
|
+
**Published:** 2026-08-08
|
|
1858
|
+
* OpenAPI spec version: 2026.16.0
|
|
1262
1859
|
*/
|
|
1263
1860
|
/**
|
|
1264
|
-
*
|
|
1861
|
+
* Tier label for this schedule option
|
|
1862
|
+
*/
|
|
1863
|
+
type PaymentScheduleOptionEvaluationType = typeof PaymentScheduleOptionEvaluationType[keyof typeof PaymentScheduleOptionEvaluationType];
|
|
1864
|
+
declare const PaymentScheduleOptionEvaluationType: {
|
|
1865
|
+
readonly Most_Affordable: "Most Affordable";
|
|
1866
|
+
readonly Best_Value: "Best Value";
|
|
1867
|
+
readonly Fastest: "Fastest";
|
|
1868
|
+
};
|
|
1869
|
+
|
|
1870
|
+
/**
|
|
1871
|
+
* Generated by orval v7.21.0 🍺
|
|
1872
|
+
* Do not edit manually.
|
|
1873
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1874
|
+
* 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.
|
|
1875
|
+
|
|
1876
|
+
**Published:** 2026-08-08
|
|
1877
|
+
* OpenAPI spec version: 2026.16.0
|
|
1878
|
+
*/
|
|
1879
|
+
|
|
1880
|
+
/**
|
|
1881
|
+
* A payment tier with three draft-frequency schedule breakdowns
|
|
1265
1882
|
* @nullable
|
|
1266
1883
|
*/
|
|
1267
|
-
type
|
|
1268
|
-
/**
|
|
1269
|
-
|
|
1270
|
-
/**
|
|
1271
|
-
|
|
1884
|
+
type PaymentScheduleOption = {
|
|
1885
|
+
/** Schedule option identifier */
|
|
1886
|
+
id?: string;
|
|
1887
|
+
/** Available draft schedules for this option (regular, split, bi-weekly) */
|
|
1888
|
+
schedules?: PaymentSchedule[];
|
|
1889
|
+
/** Tier label for this schedule option */
|
|
1890
|
+
evaluation_type?: PaymentScheduleOptionEvaluationType;
|
|
1272
1891
|
/** Program length for this option (months) */
|
|
1273
1892
|
program_length?: number;
|
|
1893
|
+
/** Total program cost for this option (USD) */
|
|
1894
|
+
program_cost?: number;
|
|
1274
1895
|
} | null;
|
|
1275
1896
|
|
|
1276
1897
|
/**
|
|
@@ -1278,7 +1899,9 @@ type PaymentOption = {
|
|
|
1278
1899
|
* Do not edit manually.
|
|
1279
1900
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1280
1901
|
* 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.
|
|
1281
|
-
|
|
1902
|
+
|
|
1903
|
+
**Published:** 2026-08-08
|
|
1904
|
+
* OpenAPI spec version: 2026.16.0
|
|
1282
1905
|
*/
|
|
1283
1906
|
|
|
1284
1907
|
/**
|
|
@@ -1286,11 +1909,11 @@ type PaymentOption = {
|
|
|
1286
1909
|
*/
|
|
1287
1910
|
interface LeadApplication {
|
|
1288
1911
|
/** Current program / opportunity stage */
|
|
1289
|
-
status?:
|
|
1912
|
+
status?: LeadApplicationStatus;
|
|
1290
1913
|
/** Program lifecycle state (e.g. Active, Closed, Cancelled) */
|
|
1291
1914
|
state?: string;
|
|
1292
1915
|
/** Client's preferred language */
|
|
1293
|
-
language?:
|
|
1916
|
+
language?: LeadApplicationLanguage;
|
|
1294
1917
|
/**
|
|
1295
1918
|
* Whether this application passed program eligibility checks
|
|
1296
1919
|
* @nullable
|
|
@@ -1311,7 +1934,7 @@ interface LeadApplication {
|
|
|
1311
1934
|
*/
|
|
1312
1935
|
conditions?: LeadCondition[] | null;
|
|
1313
1936
|
/** Sub-status of the current stage */
|
|
1314
|
-
sub_status?:
|
|
1937
|
+
sub_status?: LeadApplicationSubStatus;
|
|
1315
1938
|
/**
|
|
1316
1939
|
* DEX-specific flow status set by the partner integration
|
|
1317
1940
|
* @nullable
|
|
@@ -1407,8 +2030,10 @@ interface LeadApplication {
|
|
|
1407
2030
|
savings_vs_enrolled_debt?: number;
|
|
1408
2031
|
/** Monthly draft amount (USD) */
|
|
1409
2032
|
draft_amount?: number;
|
|
1410
|
-
/** Draft frequency type
|
|
1411
|
-
|
|
2033
|
+
/** Draft frequency type, as reported by the lead.
|
|
2034
|
+
|
|
2035
|
+
⚠️ Patched locally by `openapi/repairs.ts` — this differs from FDR's published spec. */
|
|
2036
|
+
draft_type?: LeadApplicationDraftType;
|
|
1412
2037
|
/** Date of first programme draft (YYYY-MM-DD) */
|
|
1413
2038
|
first_draft_date?: string;
|
|
1414
2039
|
/** Second draft date for bi-weekly drafts (YYYY-MM-DD) */
|
|
@@ -1472,21 +2097,21 @@ interface LeadApplication {
|
|
|
1472
2097
|
/** Other expenses amount (numeric) */
|
|
1473
2098
|
other_expenses_describe?: number;
|
|
1474
2099
|
/** Primary hardship category */
|
|
1475
|
-
hardship_category?:
|
|
2100
|
+
hardship_category?: LeadApplicationHardshipCategory;
|
|
1476
2101
|
/**
|
|
1477
2102
|
* Free-text hardship description when category is 'Other'
|
|
1478
2103
|
* @nullable
|
|
1479
2104
|
*/
|
|
1480
2105
|
hardship_category_other?: string | null;
|
|
1481
2106
|
/** Client's primary financial goal category */
|
|
1482
|
-
goal_category?:
|
|
2107
|
+
goal_category?: LeadApplicationGoalCategory;
|
|
1483
2108
|
/**
|
|
1484
2109
|
* Free-text goal when category is 'Other'
|
|
1485
2110
|
* @nullable
|
|
1486
2111
|
*/
|
|
1487
2112
|
goal_category_other?: string | null;
|
|
1488
2113
|
/** Client's secondary financial goal */
|
|
1489
|
-
secondary_goal?:
|
|
2114
|
+
secondary_goal?: LeadApplicationSecondaryGoal;
|
|
1490
2115
|
/** Justification for housing cost amount */
|
|
1491
2116
|
housing_justification?: string;
|
|
1492
2117
|
/** Justification for transportation cost amount */
|
|
@@ -1594,6 +2219,11 @@ interface LeadApplication {
|
|
|
1594
2219
|
* @nullable
|
|
1595
2220
|
*/
|
|
1596
2221
|
payment_options?: PaymentOption[] | null;
|
|
2222
|
+
/**
|
|
2223
|
+
* Payment schedule options — three program tiers (Most Affordable, Best Value, Fastest), each with regular, split, and bi-weekly draft schedule breakdowns. Present when payment_options is non-empty.
|
|
2224
|
+
* @nullable
|
|
2225
|
+
*/
|
|
2226
|
+
payment_schedule_options?: PaymentScheduleOption[] | null;
|
|
1597
2227
|
bank_details?: BankDetails;
|
|
1598
2228
|
/**
|
|
1599
2229
|
* Reasons the application is ineligible, if any. Normalised from a comma-separated string to an array of reason objects.
|
|
@@ -1607,7 +2237,9 @@ interface LeadApplication {
|
|
|
1607
2237
|
* Do not edit manually.
|
|
1608
2238
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1609
2239
|
* 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.
|
|
1610
|
-
|
|
2240
|
+
|
|
2241
|
+
**Published:** 2026-08-08
|
|
2242
|
+
* OpenAPI spec version: 2026.16.0
|
|
1611
2243
|
*/
|
|
1612
2244
|
|
|
1613
2245
|
/**
|
|
@@ -1628,7 +2260,9 @@ interface CreateLeadResponse {
|
|
|
1628
2260
|
* Do not edit manually.
|
|
1629
2261
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1630
2262
|
* 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.
|
|
1631
|
-
|
|
2263
|
+
|
|
2264
|
+
**Published:** 2026-08-08
|
|
2265
|
+
* OpenAPI spec version: 2026.16.0
|
|
1632
2266
|
*/
|
|
1633
2267
|
/**
|
|
1634
2268
|
* Consent record for soft credit pull
|
|
@@ -1644,7 +2278,9 @@ type CreditPullConsent = {
|
|
|
1644
2278
|
* Do not edit manually.
|
|
1645
2279
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1646
2280
|
* 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.
|
|
1647
|
-
|
|
2281
|
+
|
|
2282
|
+
**Published:** 2026-08-08
|
|
2283
|
+
* OpenAPI spec version: 2026.16.0
|
|
1648
2284
|
*/
|
|
1649
2285
|
/**
|
|
1650
2286
|
* Applicant signing URL details
|
|
@@ -1659,7 +2295,9 @@ interface DraApplicant {
|
|
|
1659
2295
|
* Do not edit manually.
|
|
1660
2296
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1661
2297
|
* 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.
|
|
1662
|
-
|
|
2298
|
+
|
|
2299
|
+
**Published:** 2026-08-08
|
|
2300
|
+
* OpenAPI spec version: 2026.16.0
|
|
1663
2301
|
*/
|
|
1664
2302
|
/**
|
|
1665
2303
|
* DocuSign signing method. Use 'url' for embedded signing, 'email' for standard email signing.
|
|
@@ -1675,7 +2313,9 @@ declare const DraApplicantInputSigningType: {
|
|
|
1675
2313
|
* Do not edit manually.
|
|
1676
2314
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1677
2315
|
* 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.
|
|
1678
|
-
|
|
2316
|
+
|
|
2317
|
+
**Published:** 2026-08-08
|
|
2318
|
+
* OpenAPI spec version: 2026.16.0
|
|
1679
2319
|
*/
|
|
1680
2320
|
|
|
1681
2321
|
/**
|
|
@@ -1691,7 +2331,9 @@ interface DraApplicantInput {
|
|
|
1691
2331
|
* Do not edit manually.
|
|
1692
2332
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1693
2333
|
* 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.
|
|
1694
|
-
|
|
2334
|
+
|
|
2335
|
+
**Published:** 2026-08-08
|
|
2336
|
+
* OpenAPI spec version: 2026.16.0
|
|
1695
2337
|
*/
|
|
1696
2338
|
|
|
1697
2339
|
/**
|
|
@@ -1708,7 +2350,9 @@ interface DraRequest {
|
|
|
1708
2350
|
* Do not edit manually.
|
|
1709
2351
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1710
2352
|
* 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.
|
|
1711
|
-
|
|
2353
|
+
|
|
2354
|
+
**Published:** 2026-08-08
|
|
2355
|
+
* OpenAPI spec version: 2026.16.0
|
|
1712
2356
|
*/
|
|
1713
2357
|
|
|
1714
2358
|
/**
|
|
@@ -1725,7 +2369,9 @@ interface DraResponse {
|
|
|
1725
2369
|
* Do not edit manually.
|
|
1726
2370
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1727
2371
|
* 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.
|
|
1728
|
-
|
|
2372
|
+
|
|
2373
|
+
**Published:** 2026-08-08
|
|
2374
|
+
* OpenAPI spec version: 2026.16.0
|
|
1729
2375
|
*/
|
|
1730
2376
|
/**
|
|
1731
2377
|
* Address for eligibility request
|
|
@@ -1748,7 +2394,9 @@ interface EligibilityAddress {
|
|
|
1748
2394
|
* Do not edit manually.
|
|
1749
2395
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1750
2396
|
* 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.
|
|
1751
|
-
|
|
2397
|
+
|
|
2398
|
+
**Published:** 2026-08-08
|
|
2399
|
+
* OpenAPI spec version: 2026.16.0
|
|
1752
2400
|
*/
|
|
1753
2401
|
|
|
1754
2402
|
/**
|
|
@@ -1775,7 +2423,9 @@ interface EligibilityApplicant {
|
|
|
1775
2423
|
* Do not edit manually.
|
|
1776
2424
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1777
2425
|
* 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.
|
|
1778
|
-
|
|
2426
|
+
|
|
2427
|
+
**Published:** 2026-08-08
|
|
2428
|
+
* OpenAPI spec version: 2026.16.0
|
|
1779
2429
|
*/
|
|
1780
2430
|
|
|
1781
2431
|
/**
|
|
@@ -1787,6 +2437,11 @@ interface EligibilityApplication {
|
|
|
1787
2437
|
debt_accounts?: LeadDebtAccount[];
|
|
1788
2438
|
/** Selectable payment options (3 tiers) */
|
|
1789
2439
|
payment_options?: PaymentOption[];
|
|
2440
|
+
/**
|
|
2441
|
+
* Payment schedule options — three program tiers (Most Affordable, Best Value, Fastest), each with regular, split, and bi-weekly draft schedule breakdowns. Present when payment_options is non-empty.
|
|
2442
|
+
* @nullable
|
|
2443
|
+
*/
|
|
2444
|
+
payment_schedule_options?: PaymentScheduleOption[] | null;
|
|
1790
2445
|
/** Total enrolled debt (USD) */
|
|
1791
2446
|
estimated_total_debt?: number;
|
|
1792
2447
|
/** Total cost if no action taken (USD) */
|
|
@@ -1854,7 +2509,9 @@ interface EligibilityApplication {
|
|
|
1854
2509
|
* Do not edit manually.
|
|
1855
2510
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1856
2511
|
* 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.
|
|
1857
|
-
|
|
2512
|
+
|
|
2513
|
+
**Published:** 2026-08-08
|
|
2514
|
+
* OpenAPI spec version: 2026.16.0
|
|
1858
2515
|
*/
|
|
1859
2516
|
/**
|
|
1860
2517
|
* Debt account entry for eligibility check (no-credit-pull path)
|
|
@@ -1894,7 +2551,9 @@ type EligibilityDebtAccount = {
|
|
|
1894
2551
|
* Do not edit manually.
|
|
1895
2552
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1896
2553
|
* 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.
|
|
1897
|
-
|
|
2554
|
+
|
|
2555
|
+
**Published:** 2026-08-08
|
|
2556
|
+
* OpenAPI spec version: 2026.16.0
|
|
1898
2557
|
*/
|
|
1899
2558
|
|
|
1900
2559
|
/**
|
|
@@ -1916,7 +2575,9 @@ interface EligibilityRequest {
|
|
|
1916
2575
|
* Do not edit manually.
|
|
1917
2576
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1918
2577
|
* 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.
|
|
1919
|
-
|
|
2578
|
+
|
|
2579
|
+
**Published:** 2026-08-08
|
|
2580
|
+
* OpenAPI spec version: 2026.16.0
|
|
1920
2581
|
*/
|
|
1921
2582
|
|
|
1922
2583
|
/**
|
|
@@ -1935,15 +2596,46 @@ interface EligibilityResponse {
|
|
|
1935
2596
|
* Do not edit manually.
|
|
1936
2597
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1937
2598
|
* 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.
|
|
1938
|
-
|
|
2599
|
+
|
|
2600
|
+
**Published:** 2026-08-08
|
|
2601
|
+
* OpenAPI spec version: 2026.16.0
|
|
1939
2602
|
*/
|
|
1940
2603
|
/**
|
|
1941
|
-
*
|
|
2604
|
+
* Check type identifier
|
|
1942
2605
|
*/
|
|
1943
2606
|
type ReadinessCheckType = typeof ReadinessCheckType[keyof typeof ReadinessCheckType];
|
|
1944
2607
|
declare const ReadinessCheckType: {
|
|
2608
|
+
readonly lead: "lead";
|
|
1945
2609
|
readonly uw_submission: "uw_submission";
|
|
1946
2610
|
readonly dra: "dra";
|
|
2611
|
+
readonly readiness: "readiness";
|
|
2612
|
+
};
|
|
2613
|
+
|
|
2614
|
+
/**
|
|
2615
|
+
* Generated by orval v7.21.0 🍺
|
|
2616
|
+
* Do not edit manually.
|
|
2617
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
2618
|
+
* 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.
|
|
2619
|
+
|
|
2620
|
+
**Published:** 2026-08-08
|
|
2621
|
+
* OpenAPI spec version: 2026.16.0
|
|
2622
|
+
*/
|
|
2623
|
+
/**
|
|
2624
|
+
* Stable machine-readable code you can safely branch on.
|
|
2625
|
+
*/
|
|
2626
|
+
type ReadinessErrorDetailReasonCode = typeof ReadinessErrorDetailReasonCode[keyof typeof ReadinessErrorDetailReasonCode];
|
|
2627
|
+
declare const ReadinessErrorDetailReasonCode: {
|
|
2628
|
+
readonly REQUIRED: "REQUIRED";
|
|
2629
|
+
readonly DUPLICATE_EMAIL: "DUPLICATE_EMAIL";
|
|
2630
|
+
readonly HARDSHIP_CHECK_FAILED: "HARDSHIP_CHECK_FAILED";
|
|
2631
|
+
readonly PO_BOX_NOT_ALLOWED: "PO_BOX_NOT_ALLOWED";
|
|
2632
|
+
readonly DEBT_ACCOUNTS_MISSING: "DEBT_ACCOUNTS_MISSING";
|
|
2633
|
+
readonly MEDICAL_DEBT_INVALID: "MEDICAL_DEBT_INVALID";
|
|
2634
|
+
readonly MANUAL_DEBT_INVALID: "MANUAL_DEBT_INVALID";
|
|
2635
|
+
readonly DEBT_TOTAL_MISMATCH: "DEBT_TOTAL_MISMATCH";
|
|
2636
|
+
readonly PROGRAM_START_DATE_INVALID: "PROGRAM_START_DATE_INVALID";
|
|
2637
|
+
readonly CONDITION_NOT_VERIFIED: "CONDITION_NOT_VERIFIED";
|
|
2638
|
+
readonly PROVISIONAL_DEBT_ABOVE_THRESHOLD: "PROVISIONAL_DEBT_ABOVE_THRESHOLD";
|
|
1947
2639
|
};
|
|
1948
2640
|
|
|
1949
2641
|
/**
|
|
@@ -1951,19 +2643,55 @@ declare const ReadinessCheckType: {
|
|
|
1951
2643
|
* Do not edit manually.
|
|
1952
2644
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1953
2645
|
* 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.
|
|
1954
|
-
|
|
2646
|
+
|
|
2647
|
+
**Published:** 2026-08-08
|
|
2648
|
+
* OpenAPI spec version: 2026.16.0
|
|
2649
|
+
*/
|
|
2650
|
+
|
|
2651
|
+
/**
|
|
2652
|
+
* Structured failure entry within a readiness check
|
|
2653
|
+
* @nullable
|
|
2654
|
+
*/
|
|
2655
|
+
type ReadinessErrorDetail = {
|
|
2656
|
+
/**
|
|
2657
|
+
* Dotted JSON path of the input field that caused the failure (snake_case). Omitted when the failure is not tied to a specific field.
|
|
2658
|
+
* @nullable
|
|
2659
|
+
*/
|
|
2660
|
+
field?: string | null;
|
|
2661
|
+
/** Stable machine-readable code you can safely branch on. */
|
|
2662
|
+
reason_code?: ReadinessErrorDetailReasonCode;
|
|
2663
|
+
/** Human-readable explanation — same text as in errors[]. May be reworded over time; do not match on this value. */
|
|
2664
|
+
message?: string;
|
|
2665
|
+
} | null;
|
|
2666
|
+
|
|
2667
|
+
/**
|
|
2668
|
+
* Generated by orval v7.21.0 🍺
|
|
2669
|
+
* Do not edit manually.
|
|
2670
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
2671
|
+
* 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.
|
|
2672
|
+
|
|
2673
|
+
**Published:** 2026-08-08
|
|
2674
|
+
* OpenAPI spec version: 2026.16.0
|
|
1955
2675
|
*/
|
|
1956
2676
|
|
|
1957
2677
|
/**
|
|
1958
|
-
*
|
|
2678
|
+
* Individual readiness check result
|
|
1959
2679
|
*/
|
|
1960
2680
|
interface ReadinessCheck {
|
|
1961
|
-
/**
|
|
2681
|
+
/** Check type identifier */
|
|
1962
2682
|
type?: ReadinessCheckType;
|
|
1963
|
-
/** Whether this
|
|
2683
|
+
/** Whether this check passed */
|
|
1964
2684
|
verified?: boolean;
|
|
1965
|
-
/**
|
|
1966
|
-
|
|
2685
|
+
/**
|
|
2686
|
+
* Validation error messages if the check failed
|
|
2687
|
+
* @nullable
|
|
2688
|
+
*/
|
|
2689
|
+
errors?: (string | null)[] | null;
|
|
2690
|
+
/**
|
|
2691
|
+
* Structured failure entries for this check. Present only when the check fails. Prefer this over errors[] for programmatic handling — reason_code is stable and safe to branch on. errors[] is kept for backwards compatibility.
|
|
2692
|
+
* @nullable
|
|
2693
|
+
*/
|
|
2694
|
+
error_details?: ReadinessErrorDetail[] | null;
|
|
1967
2695
|
}
|
|
1968
2696
|
|
|
1969
2697
|
/**
|
|
@@ -1971,11 +2699,15 @@ interface ReadinessCheck {
|
|
|
1971
2699
|
* Do not edit manually.
|
|
1972
2700
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1973
2701
|
* 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
|
-
|
|
2702
|
+
|
|
2703
|
+
**Published:** 2026-08-08
|
|
2704
|
+
* OpenAPI spec version: 2026.16.0
|
|
1975
2705
|
*/
|
|
1976
2706
|
|
|
1977
2707
|
/**
|
|
1978
|
-
* Readiness check breakdown
|
|
2708
|
+
* Readiness check breakdown returned inside a gated error response.
|
|
2709
|
+
|
|
2710
|
+
⚠️ Patched locally by `openapi/repairs.ts` — this differs from FDR's published spec.
|
|
1979
2711
|
*/
|
|
1980
2712
|
interface ErrorDetails {
|
|
1981
2713
|
/** Per-gate check results */
|
|
@@ -1984,6 +2716,8 @@ interface ErrorDetails {
|
|
|
1984
2716
|
is_program_refresh_required?: boolean;
|
|
1985
2717
|
/** Whether the application is currently UW-approved */
|
|
1986
2718
|
is_uw_approved?: boolean;
|
|
2719
|
+
/** Human-readable summary of the gate failure */
|
|
2720
|
+
message?: string;
|
|
1987
2721
|
}
|
|
1988
2722
|
|
|
1989
2723
|
/**
|
|
@@ -1991,7 +2725,9 @@ interface ErrorDetails {
|
|
|
1991
2725
|
* Do not edit manually.
|
|
1992
2726
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1993
2727
|
* 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.
|
|
1994
|
-
|
|
2728
|
+
|
|
2729
|
+
**Published:** 2026-08-08
|
|
2730
|
+
* OpenAPI spec version: 2026.16.0
|
|
1995
2731
|
*/
|
|
1996
2732
|
/**
|
|
1997
2733
|
* Address — used for current and mailing address updates
|
|
@@ -2014,7 +2750,9 @@ interface PatchAddress {
|
|
|
2014
2750
|
* Do not edit manually.
|
|
2015
2751
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2016
2752
|
* 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.
|
|
2017
|
-
|
|
2753
|
+
|
|
2754
|
+
**Published:** 2026-08-08
|
|
2755
|
+
* OpenAPI spec version: 2026.16.0
|
|
2018
2756
|
*/
|
|
2019
2757
|
|
|
2020
2758
|
/**
|
|
@@ -2084,7 +2822,51 @@ interface PatchApplicant {
|
|
|
2084
2822
|
* Do not edit manually.
|
|
2085
2823
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2086
2824
|
* 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.
|
|
2087
|
-
|
|
2825
|
+
|
|
2826
|
+
**Published:** 2026-08-08
|
|
2827
|
+
* OpenAPI spec version: 2026.16.0
|
|
2828
|
+
*/
|
|
2829
|
+
/**
|
|
2830
|
+
* Hardship category
|
|
2831
|
+
*/
|
|
2832
|
+
type LeadPatchRequestHardshipCategory = typeof LeadPatchRequestHardshipCategory[keyof typeof LeadPatchRequestHardshipCategory];
|
|
2833
|
+
declare const LeadPatchRequestHardshipCategory: {
|
|
2834
|
+
readonly Job_Loss: "Job Loss";
|
|
2835
|
+
readonly Reduced_Income: "Reduced Income";
|
|
2836
|
+
readonly Medical: "Medical";
|
|
2837
|
+
readonly Divorce: "Divorce";
|
|
2838
|
+
readonly Unexpected_Expenses: "Unexpected Expenses";
|
|
2839
|
+
readonly Other: "Other";
|
|
2840
|
+
};
|
|
2841
|
+
|
|
2842
|
+
/**
|
|
2843
|
+
* Generated by orval v7.21.0 🍺
|
|
2844
|
+
* Do not edit manually.
|
|
2845
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
2846
|
+
* 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.
|
|
2847
|
+
|
|
2848
|
+
**Published:** 2026-08-08
|
|
2849
|
+
* OpenAPI spec version: 2026.16.0
|
|
2850
|
+
*/
|
|
2851
|
+
/**
|
|
2852
|
+
* Goal category
|
|
2853
|
+
*/
|
|
2854
|
+
type LeadPatchRequestGoalCategory = typeof LeadPatchRequestGoalCategory[keyof typeof LeadPatchRequestGoalCategory];
|
|
2855
|
+
declare const LeadPatchRequestGoalCategory: {
|
|
2856
|
+
readonly Avoid_Bankruptcy: "Avoid Bankruptcy";
|
|
2857
|
+
readonly Get_out_of_Debt: "Get out of Debt";
|
|
2858
|
+
readonly 'Build_personal_wealth,_savings': "Build personal wealth, savings";
|
|
2859
|
+
readonly Relieve_pressure_of_monthly_bills: "Relieve pressure of monthly bills";
|
|
2860
|
+
};
|
|
2861
|
+
|
|
2862
|
+
/**
|
|
2863
|
+
* Generated by orval v7.21.0 🍺
|
|
2864
|
+
* Do not edit manually.
|
|
2865
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
2866
|
+
* 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.
|
|
2867
|
+
|
|
2868
|
+
**Published:** 2026-08-08
|
|
2869
|
+
* OpenAPI spec version: 2026.16.0
|
|
2088
2870
|
*/
|
|
2089
2871
|
/**
|
|
2090
2872
|
* Condition to verify (lead-level or debt-account-level)
|
|
@@ -2103,7 +2885,9 @@ interface PatchCondition {
|
|
|
2103
2885
|
* Do not edit manually.
|
|
2104
2886
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2105
2887
|
* 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.
|
|
2106
|
-
|
|
2888
|
+
|
|
2889
|
+
**Published:** 2026-08-08
|
|
2890
|
+
* OpenAPI spec version: 2026.16.0
|
|
2107
2891
|
*/
|
|
2108
2892
|
|
|
2109
2893
|
/**
|
|
@@ -2125,7 +2909,9 @@ interface PatchDebtAccount {
|
|
|
2125
2909
|
* Do not edit manually.
|
|
2126
2910
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2127
2911
|
* 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.
|
|
2128
|
-
|
|
2912
|
+
|
|
2913
|
+
**Published:** 2026-08-08
|
|
2914
|
+
* OpenAPI spec version: 2026.16.0
|
|
2129
2915
|
*/
|
|
2130
2916
|
/**
|
|
2131
2917
|
* Co-applicant fields that can be patched
|
|
@@ -2184,7 +2970,9 @@ interface PatchCoApplicant {
|
|
|
2184
2970
|
* Do not edit manually.
|
|
2185
2971
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2186
2972
|
* 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.
|
|
2187
|
-
|
|
2973
|
+
|
|
2974
|
+
**Published:** 2026-08-08
|
|
2975
|
+
* OpenAPI spec version: 2026.16.0
|
|
2188
2976
|
*/
|
|
2189
2977
|
|
|
2190
2978
|
/**
|
|
@@ -2199,11 +2987,11 @@ interface LeadPatchRequest {
|
|
|
2199
2987
|
/** Desired monthly deposit amount */
|
|
2200
2988
|
monthly_deposit?: number;
|
|
2201
2989
|
/** Hardship category */
|
|
2202
|
-
hardship_category?:
|
|
2990
|
+
hardship_category?: LeadPatchRequestHardshipCategory;
|
|
2203
2991
|
/** Free-text hardship description when category is 'Other' */
|
|
2204
2992
|
hardship_category_other?: string;
|
|
2205
2993
|
/** Goal category */
|
|
2206
|
-
goal_category?:
|
|
2994
|
+
goal_category?: LeadPatchRequestGoalCategory;
|
|
2207
2995
|
/** Free-text goal description when category is 'Other' */
|
|
2208
2996
|
goal_category_other?: string;
|
|
2209
2997
|
/** Monthly food expenses */
|
|
@@ -2284,7 +3072,9 @@ interface LeadPatchRequest {
|
|
|
2284
3072
|
* Do not edit manually.
|
|
2285
3073
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2286
3074
|
* 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.
|
|
2287
|
-
|
|
3075
|
+
|
|
3076
|
+
**Published:** 2026-08-08
|
|
3077
|
+
* OpenAPI spec version: 2026.16.0
|
|
2288
3078
|
*/
|
|
2289
3079
|
|
|
2290
3080
|
/**
|
|
@@ -2311,7 +3101,9 @@ type LeadReadiness = {
|
|
|
2311
3101
|
* Do not edit manually.
|
|
2312
3102
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2313
3103
|
* 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.
|
|
2314
|
-
|
|
3104
|
+
|
|
3105
|
+
**Published:** 2026-08-08
|
|
3106
|
+
* OpenAPI spec version: 2026.16.0
|
|
2315
3107
|
*/
|
|
2316
3108
|
|
|
2317
3109
|
/**
|
|
@@ -2331,7 +3123,9 @@ interface LeadResponse {
|
|
|
2331
3123
|
* Do not edit manually.
|
|
2332
3124
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2333
3125
|
* 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.
|
|
2334
|
-
|
|
3126
|
+
|
|
3127
|
+
**Published:** 2026-08-08
|
|
3128
|
+
* OpenAPI spec version: 2026.16.0
|
|
2335
3129
|
*/
|
|
2336
3130
|
/**
|
|
2337
3131
|
* Applicant mailing address.
|
|
@@ -2352,7 +3146,9 @@ interface MailingAddress {
|
|
|
2352
3146
|
* Do not edit manually.
|
|
2353
3147
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2354
3148
|
* 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.
|
|
2355
|
-
|
|
3149
|
+
|
|
3150
|
+
**Published:** 2026-08-08
|
|
3151
|
+
* OpenAPI spec version: 2026.16.0
|
|
2356
3152
|
*/
|
|
2357
3153
|
/**
|
|
2358
3154
|
* Marketing tracking metadata
|
|
@@ -2371,7 +3167,9 @@ interface Tracking {
|
|
|
2371
3167
|
* Do not edit manually.
|
|
2372
3168
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2373
3169
|
* 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.
|
|
2374
|
-
|
|
3170
|
+
|
|
3171
|
+
**Published:** 2026-08-08
|
|
3172
|
+
* OpenAPI spec version: 2026.16.0
|
|
2375
3173
|
*/
|
|
2376
3174
|
|
|
2377
3175
|
/**
|
|
@@ -2404,7 +3202,9 @@ interface LeadTransferRequest {
|
|
|
2404
3202
|
* Do not edit manually.
|
|
2405
3203
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2406
3204
|
* 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.
|
|
2407
|
-
|
|
3205
|
+
|
|
3206
|
+
**Published:** 2026-08-08
|
|
3207
|
+
* OpenAPI spec version: 2026.16.0
|
|
2408
3208
|
*/
|
|
2409
3209
|
/**
|
|
2410
3210
|
* Evaluation outcome: 'accepted' or 'rejected'.
|
|
@@ -2420,7 +3220,9 @@ declare const LeadTransferResponseResponse: {
|
|
|
2420
3220
|
* Do not edit manually.
|
|
2421
3221
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2422
3222
|
* 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
|
-
|
|
3223
|
+
|
|
3224
|
+
**Published:** 2026-08-08
|
|
3225
|
+
* OpenAPI spec version: 2026.16.0
|
|
2424
3226
|
*/
|
|
2425
3227
|
|
|
2426
3228
|
/**
|
|
@@ -2463,7 +3265,9 @@ interface LeadTransferResponse {
|
|
|
2463
3265
|
* Do not edit manually.
|
|
2464
3266
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2465
3267
|
* 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.
|
|
2466
|
-
|
|
3268
|
+
|
|
3269
|
+
**Published:** 2026-08-08
|
|
3270
|
+
* OpenAPI spec version: 2026.16.0
|
|
2467
3271
|
*/
|
|
2468
3272
|
/**
|
|
2469
3273
|
* Request body for async program generation (v1)
|
|
@@ -2480,7 +3284,68 @@ interface ProgramRequest {
|
|
|
2480
3284
|
* Do not edit manually.
|
|
2481
3285
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2482
3286
|
* 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.
|
|
2483
|
-
|
|
3287
|
+
|
|
3288
|
+
**Published:** 2026-08-08
|
|
3289
|
+
* OpenAPI spec version: 2026.16.0
|
|
3290
|
+
*/
|
|
3291
|
+
/**
|
|
3292
|
+
* Applicant reference for a program selection — the id is all this endpoint uses.
|
|
3293
|
+
|
|
3294
|
+
⚠️ Patched locally by `openapi/repairs.ts` — this differs from FDR's published spec.
|
|
3295
|
+
*/
|
|
3296
|
+
interface ProgramSelectionApplicant {
|
|
3297
|
+
/** FDR applicant ID — the applicant's passport across all systems. */
|
|
3298
|
+
fdr_applicant_id: string;
|
|
3299
|
+
}
|
|
3300
|
+
|
|
3301
|
+
/**
|
|
3302
|
+
* Generated by orval v7.21.0 🍺
|
|
3303
|
+
* Do not edit manually.
|
|
3304
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
3305
|
+
* 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.
|
|
3306
|
+
|
|
3307
|
+
**Published:** 2026-08-08
|
|
3308
|
+
* OpenAPI spec version: 2026.16.0
|
|
3309
|
+
*/
|
|
3310
|
+
/**
|
|
3311
|
+
* Selected draft schedule type from payment_schedule_options
|
|
3312
|
+
*/
|
|
3313
|
+
type ProgramSelectionRequestDraftType = typeof ProgramSelectionRequestDraftType[keyof typeof ProgramSelectionRequestDraftType];
|
|
3314
|
+
declare const ProgramSelectionRequestDraftType: {
|
|
3315
|
+
readonly regular: "regular";
|
|
3316
|
+
readonly split: "split";
|
|
3317
|
+
readonly 'bi-weekly': "bi-weekly";
|
|
3318
|
+
};
|
|
3319
|
+
|
|
3320
|
+
/**
|
|
3321
|
+
* Generated by orval v7.21.0 🍺
|
|
3322
|
+
* Do not edit manually.
|
|
3323
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
3324
|
+
* 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.
|
|
3325
|
+
|
|
3326
|
+
**Published:** 2026-08-08
|
|
3327
|
+
* OpenAPI spec version: 2026.16.0
|
|
3328
|
+
*/
|
|
3329
|
+
|
|
3330
|
+
/**
|
|
3331
|
+
* Request body for selecting a payment schedule for an existing lead
|
|
3332
|
+
*/
|
|
3333
|
+
interface ProgramSelectionRequest {
|
|
3334
|
+
applicant: ProgramSelectionApplicant;
|
|
3335
|
+
/** Selected draft schedule type from payment_schedule_options */
|
|
3336
|
+
draft_type?: ProgramSelectionRequestDraftType;
|
|
3337
|
+
/** The estimated_monthly_payment value from the chosen payment_schedule_options[].schedules[] entry */
|
|
3338
|
+
estimated_monthly_payment?: number;
|
|
3339
|
+
}
|
|
3340
|
+
|
|
3341
|
+
/**
|
|
3342
|
+
* Generated by orval v7.21.0 🍺
|
|
3343
|
+
* Do not edit manually.
|
|
3344
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
3345
|
+
* 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.
|
|
3346
|
+
|
|
3347
|
+
**Published:** 2026-08-08
|
|
3348
|
+
* OpenAPI spec version: 2026.16.0
|
|
2484
3349
|
*/
|
|
2485
3350
|
/**
|
|
2486
3351
|
* Request body for creating a Program Summary Recording task (RWA-2427)
|
|
@@ -2505,7 +3370,9 @@ interface ProgramSummaryTaskRequest {
|
|
|
2505
3370
|
* Do not edit manually.
|
|
2506
3371
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2507
3372
|
* 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.
|
|
2508
|
-
|
|
3373
|
+
|
|
3374
|
+
**Published:** 2026-08-08
|
|
3375
|
+
* OpenAPI spec version: 2026.16.0
|
|
2509
3376
|
*/
|
|
2510
3377
|
/**
|
|
2511
3378
|
* Response body for a successfully created Program Summary Recording task
|
|
@@ -2530,37 +3397,24 @@ interface ProgramSummaryTaskResponse {
|
|
|
2530
3397
|
* Do not edit manually.
|
|
2531
3398
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2532
3399
|
* 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.
|
|
2533
|
-
* OpenAPI spec version: 2026.15.0
|
|
2534
|
-
*/
|
|
2535
|
-
/**
|
|
2536
|
-
* Error classification code
|
|
2537
|
-
*/
|
|
2538
|
-
type ReadinessErrorResponseErrorCode = typeof ReadinessErrorResponseErrorCode[keyof typeof ReadinessErrorResponseErrorCode];
|
|
2539
|
-
declare const ReadinessErrorResponseErrorCode: {
|
|
2540
|
-
readonly ER40301: "ER40301";
|
|
2541
|
-
readonly ER40305: "ER40305";
|
|
2542
|
-
};
|
|
2543
3400
|
|
|
2544
|
-
|
|
2545
|
-
*
|
|
2546
|
-
* Do not edit manually.
|
|
2547
|
-
* ARPC — Achieve Resolution Partner Connect API
|
|
2548
|
-
* 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.
|
|
2549
|
-
* OpenAPI spec version: 2026.15.0
|
|
3401
|
+
**Published:** 2026-08-08
|
|
3402
|
+
* OpenAPI spec version: 2026.16.0
|
|
2550
3403
|
*/
|
|
2551
3404
|
|
|
2552
3405
|
/**
|
|
2553
|
-
* Error
|
|
3406
|
+
* Error body returned when a readiness gate blocks UW submission. Observed live as a 400 with error_code ER40301.
|
|
3407
|
+
|
|
3408
|
+
⚠️ Patched locally by `openapi/repairs.ts` — this differs from FDR's published spec.
|
|
2554
3409
|
*/
|
|
2555
3410
|
interface ReadinessErrorResponse {
|
|
2556
|
-
/** UTC timestamp of the error */
|
|
2557
|
-
timestamp?: string;
|
|
2558
|
-
/** HTTP status code */
|
|
2559
3411
|
status?: number;
|
|
2560
3412
|
/** Short error message */
|
|
2561
3413
|
error?: string;
|
|
2562
3414
|
/** Error classification code */
|
|
2563
|
-
error_code?:
|
|
3415
|
+
error_code?: string;
|
|
3416
|
+
/** UTC timestamp of the error */
|
|
3417
|
+
timestamp?: string;
|
|
2564
3418
|
/** Correlation ID for distributed tracing */
|
|
2565
3419
|
x_correlation_id?: string;
|
|
2566
3420
|
error_details?: ErrorDetails;
|
|
@@ -2571,7 +3425,9 @@ interface ReadinessErrorResponse {
|
|
|
2571
3425
|
* Do not edit manually.
|
|
2572
3426
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2573
3427
|
* 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.
|
|
2574
|
-
|
|
3428
|
+
|
|
3429
|
+
**Published:** 2026-08-08
|
|
3430
|
+
* OpenAPI spec version: 2026.16.0
|
|
2575
3431
|
*/
|
|
2576
3432
|
|
|
2577
3433
|
/**
|
|
@@ -2597,18 +3453,18 @@ interface ReadinessResponse {
|
|
|
2597
3453
|
* Do not edit manually.
|
|
2598
3454
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2599
3455
|
* 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.
|
|
2600
|
-
|
|
3456
|
+
|
|
3457
|
+
**Published:** 2026-08-08
|
|
3458
|
+
* OpenAPI spec version: 2026.16.0
|
|
2601
3459
|
*/
|
|
3460
|
+
|
|
2602
3461
|
/**
|
|
2603
|
-
*
|
|
3462
|
+
* Request body for registering a new applicant in the v2 DEX surface
|
|
2604
3463
|
*/
|
|
2605
|
-
interface
|
|
2606
|
-
/**
|
|
2607
|
-
|
|
2608
|
-
|
|
2609
|
-
business_flow?: string;
|
|
2610
|
-
/** Salesforce ID of the created achieve__Applicant__c record */
|
|
2611
|
-
salesforce_id?: string;
|
|
3464
|
+
interface RegisterApplicantV2Request {
|
|
3465
|
+
/** Email of the seller agent to be set as the Salesforce record owner */
|
|
3466
|
+
seller_agent_email?: string;
|
|
3467
|
+
applicant: Applicant;
|
|
2612
3468
|
}
|
|
2613
3469
|
|
|
2614
3470
|
/**
|
|
@@ -2616,16 +3472,22 @@ interface RegisterApplicantResponse {
|
|
|
2616
3472
|
* Do not edit manually.
|
|
2617
3473
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2618
3474
|
* 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.
|
|
2619
|
-
* OpenAPI spec version: 2026.15.0
|
|
2620
|
-
*/
|
|
2621
3475
|
|
|
3476
|
+
**Published:** 2026-08-08
|
|
3477
|
+
* OpenAPI spec version: 2026.16.0
|
|
3478
|
+
*/
|
|
2622
3479
|
/**
|
|
2623
|
-
*
|
|
3480
|
+
* Response returned after successfully registering an applicant via POST /v2/applicant/register
|
|
2624
3481
|
*/
|
|
2625
|
-
interface
|
|
2626
|
-
/**
|
|
2627
|
-
|
|
2628
|
-
|
|
3482
|
+
interface RegisterApplicantV2Response {
|
|
3483
|
+
/** Registration status */
|
|
3484
|
+
status?: string;
|
|
3485
|
+
/** Business flow / seller identifier derived from the OAuth token used (e.g. SSI, TTTM) */
|
|
3486
|
+
business_flow?: string;
|
|
3487
|
+
/** Salesforce ID of the created achieve__Applicant__c record */
|
|
3488
|
+
salesforce_id?: string;
|
|
3489
|
+
/** FDR applicant ID associated with this registration. If not provided in the request, it is generated server-side and returned here. */
|
|
3490
|
+
fdr_applicant_id?: string;
|
|
2629
3491
|
}
|
|
2630
3492
|
|
|
2631
3493
|
/**
|
|
@@ -2633,7 +3495,9 @@ interface RegisterApplicantV2Request {
|
|
|
2633
3495
|
* Do not edit manually.
|
|
2634
3496
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2635
3497
|
* 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.
|
|
2636
|
-
|
|
3498
|
+
|
|
3499
|
+
**Published:** 2026-08-08
|
|
3500
|
+
* OpenAPI spec version: 2026.16.0
|
|
2637
3501
|
*/
|
|
2638
3502
|
|
|
2639
3503
|
/**
|
|
@@ -2658,7 +3522,9 @@ interface SpinwheelNetworkUserRequest {
|
|
|
2658
3522
|
* Do not edit manually.
|
|
2659
3523
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2660
3524
|
* 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.
|
|
2661
|
-
|
|
3525
|
+
|
|
3526
|
+
**Published:** 2026-08-08
|
|
3527
|
+
* OpenAPI spec version: 2026.16.0
|
|
2662
3528
|
*/
|
|
2663
3529
|
/**
|
|
2664
3530
|
* Result of creating or connecting a Spinwheel network user
|
|
@@ -2675,7 +3541,51 @@ interface SpinwheelNetworkUserResponse {
|
|
|
2675
3541
|
* Do not edit manually.
|
|
2676
3542
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2677
3543
|
* 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.
|
|
2678
|
-
|
|
3544
|
+
|
|
3545
|
+
**Published:** 2026-08-08
|
|
3546
|
+
* OpenAPI spec version: 2026.16.0
|
|
3547
|
+
*/
|
|
3548
|
+
/**
|
|
3549
|
+
* Primary hardship category
|
|
3550
|
+
*/
|
|
3551
|
+
type StatelessReadinessRequestHardshipCategory = typeof StatelessReadinessRequestHardshipCategory[keyof typeof StatelessReadinessRequestHardshipCategory];
|
|
3552
|
+
declare const StatelessReadinessRequestHardshipCategory: {
|
|
3553
|
+
readonly Job_Loss: "Job Loss";
|
|
3554
|
+
readonly Reduced_Income: "Reduced Income";
|
|
3555
|
+
readonly Medical: "Medical";
|
|
3556
|
+
readonly Divorce: "Divorce";
|
|
3557
|
+
readonly Unexpected_Expenses: "Unexpected Expenses";
|
|
3558
|
+
readonly Other: "Other";
|
|
3559
|
+
};
|
|
3560
|
+
|
|
3561
|
+
/**
|
|
3562
|
+
* Generated by orval v7.21.0 🍺
|
|
3563
|
+
* Do not edit manually.
|
|
3564
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
3565
|
+
* 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.
|
|
3566
|
+
|
|
3567
|
+
**Published:** 2026-08-08
|
|
3568
|
+
* OpenAPI spec version: 2026.16.0
|
|
3569
|
+
*/
|
|
3570
|
+
/**
|
|
3571
|
+
* Primary goal category
|
|
3572
|
+
*/
|
|
3573
|
+
type StatelessReadinessRequestGoalCategory = typeof StatelessReadinessRequestGoalCategory[keyof typeof StatelessReadinessRequestGoalCategory];
|
|
3574
|
+
declare const StatelessReadinessRequestGoalCategory: {
|
|
3575
|
+
readonly Avoid_Bankruptcy: "Avoid Bankruptcy";
|
|
3576
|
+
readonly Get_out_of_Debt: "Get out of Debt";
|
|
3577
|
+
readonly 'Build_personal_wealth,_savings': "Build personal wealth, savings";
|
|
3578
|
+
readonly Relieve_pressure_of_monthly_bills: "Relieve pressure of monthly bills";
|
|
3579
|
+
};
|
|
3580
|
+
|
|
3581
|
+
/**
|
|
3582
|
+
* Generated by orval v7.21.0 🍺
|
|
3583
|
+
* Do not edit manually.
|
|
3584
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
3585
|
+
* 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.
|
|
3586
|
+
|
|
3587
|
+
**Published:** 2026-08-08
|
|
3588
|
+
* OpenAPI spec version: 2026.16.0
|
|
2679
3589
|
*/
|
|
2680
3590
|
|
|
2681
3591
|
/**
|
|
@@ -2715,11 +3625,11 @@ interface StatelessReadinessRequest {
|
|
|
2715
3625
|
/** Total business debt amount */
|
|
2716
3626
|
business_debt?: number;
|
|
2717
3627
|
/** Primary hardship category */
|
|
2718
|
-
hardship_category?:
|
|
3628
|
+
hardship_category?: StatelessReadinessRequestHardshipCategory;
|
|
2719
3629
|
/** Free-text description when hardship category is 'other' */
|
|
2720
3630
|
hardship_category_other?: string;
|
|
2721
3631
|
/** Primary goal category */
|
|
2722
|
-
goal_category?:
|
|
3632
|
+
goal_category?: StatelessReadinessRequestGoalCategory;
|
|
2723
3633
|
/** Free-text description when goal category is 'other' */
|
|
2724
3634
|
goal_category_other?: string;
|
|
2725
3635
|
/** Justification for food expense amount */
|
|
@@ -2812,7 +3722,9 @@ interface StatelessReadinessRequest {
|
|
|
2812
3722
|
* Do not edit manually.
|
|
2813
3723
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2814
3724
|
* 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.
|
|
2815
|
-
|
|
3725
|
+
|
|
3726
|
+
**Published:** 2026-08-08
|
|
3727
|
+
* OpenAPI spec version: 2026.16.0
|
|
2816
3728
|
*/
|
|
2817
3729
|
|
|
2818
3730
|
/**
|
|
@@ -2834,6 +3746,43 @@ interface UwSubmissionV2Response {
|
|
|
2834
3746
|
banking_disclosure_email_message?: string | null;
|
|
2835
3747
|
}
|
|
2836
3748
|
|
|
3749
|
+
/**
|
|
3750
|
+
* FDR's API speaks two vocabularies for the same value. You *send* a lowercase
|
|
3751
|
+
* schedule code (`bi-weekly`) to `selectProgram`; the lead *reports* a
|
|
3752
|
+
* capitalised label (`Bi-Weekly`) back on `application.draft_type`. Nothing in
|
|
3753
|
+
* the spec connects them, and the mismatch is silent — comparing what you sent
|
|
3754
|
+
* against what came back always looks like a failure.
|
|
3755
|
+
*
|
|
3756
|
+
* The labels below were confirmed against live STG by selecting each draft type
|
|
3757
|
+
* in turn, not read off the spec: FDR documents `Monthly [Regular]` and
|
|
3758
|
+
* `Twice Monthly [Split]`, and the API returns neither (see the
|
|
3759
|
+
* `lead-draft-type-values` repair in `openapi/repairs.ts`).
|
|
3760
|
+
*
|
|
3761
|
+
* Scope is narrow: `LeadApplication.draft_type` is the only label-valued site
|
|
3762
|
+
* in the whole spec. `PaymentSchedule` and `ProgramSelectionRequest` are both
|
|
3763
|
+
* already lowercase, and `LeadPatchRequest` has no `draft_type` at all, so
|
|
3764
|
+
* `selectProgram` is the only write path.
|
|
3765
|
+
*
|
|
3766
|
+
* These maps are annotated as `Record<>` over the generated enums on purpose:
|
|
3767
|
+
* if FDR ever adds a fourth draft type, codegen widens the enum and these fail
|
|
3768
|
+
* to compile until someone fills in the new key. The mapping keeps itself
|
|
3769
|
+
* honest without any bespoke assertion.
|
|
3770
|
+
*/
|
|
3771
|
+
/** Schedule code → the label the lead reports back. */
|
|
3772
|
+
declare const DRAFT_TYPE_LABEL: Record<ProgramSelectionRequestDraftType, LeadApplicationDraftType>;
|
|
3773
|
+
/** Lead-reported label → the schedule code `selectProgram` accepts. */
|
|
3774
|
+
declare const DRAFT_TYPE_CODE: Record<LeadApplicationDraftType, ProgramSelectionRequestDraftType>;
|
|
3775
|
+
/**
|
|
3776
|
+
* Read a lead's current draft type as a value you can hand straight back to
|
|
3777
|
+
* `selectProgram` — closing the round-trip FDR's two vocabularies leave open.
|
|
3778
|
+
*
|
|
3779
|
+
* Returns `undefined` when the lead has no selection yet, and also when the
|
|
3780
|
+
* label isn't one we know: the server can start returning a new picklist value
|
|
3781
|
+
* before we've regenerated against a newer spec, and guessing would be worse
|
|
3782
|
+
* than admitting we don't recognise it.
|
|
3783
|
+
*/
|
|
3784
|
+
declare const draftTypeOf: (application: LeadApplication | undefined | null) => ProgramSelectionRequestDraftType | undefined;
|
|
3785
|
+
|
|
2837
3786
|
/**
|
|
2838
3787
|
* ARPC SDK — a typed, agnostic client for FDR's ARPC DEX API (Achieve
|
|
2839
3788
|
* Resolution Partner Connect, Digital Enrollment Experience).
|
|
@@ -2878,6 +3827,7 @@ declare class ArpcSDK {
|
|
|
2878
3827
|
/** The full typed endpoint surface — one method per gateway operation. */
|
|
2879
3828
|
readonly api: {
|
|
2880
3829
|
createLeadSync: (createLeadRequest: CreateLeadRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<CreateLeadResponse>>;
|
|
3830
|
+
selectProgram: (programSelectionRequest: ProgramSelectionRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<LeadResponse>>;
|
|
2881
3831
|
checkApplicationReadiness: (statelessReadinessRequest: StatelessReadinessRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<ReadinessResponse>>;
|
|
2882
3832
|
createSpinwheelNetworkUser: (spinwheelNetworkUserRequest: SpinwheelNetworkUserRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<SpinwheelNetworkUserResponse>>;
|
|
2883
3833
|
updateApplicationBankDetails: (applicantId: string, bankUpdateRequest: BankUpdateRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<LeadResponse>>;
|
|
@@ -2887,7 +3837,7 @@ declare class ArpcSDK {
|
|
|
2887
3837
|
patchLead: (fdrApplicantId: string, leadPatchRequest: LeadPatchRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<LeadResponse>>;
|
|
2888
3838
|
getApplicationReadiness: (applicantId: string, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<ReadinessResponse>>;
|
|
2889
3839
|
generateDra: (applicantId: string, draRequest: DraRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<DraResponse>>;
|
|
2890
|
-
registerApplicantV2: (registerApplicantV2Request: RegisterApplicantV2Request, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<
|
|
3840
|
+
registerApplicantV2: (registerApplicantV2Request: RegisterApplicantV2Request, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<RegisterApplicantV2Response>>;
|
|
2891
3841
|
generateProgramV1: (programRequest: ProgramRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<LeadResponse>>;
|
|
2892
3842
|
checkEligibility: (eligibilityRequest: EligibilityRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<EligibilityResponse>>;
|
|
2893
3843
|
uwSubmissionV2: (fdrApplicantId: string, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<UwSubmissionV2Response>>;
|
|
@@ -2896,4 +3846,4 @@ declare class ArpcSDK {
|
|
|
2896
3846
|
constructor(config: ArpcConfig);
|
|
2897
3847
|
}
|
|
2898
3848
|
|
|
2899
|
-
export { type ARPCErrorResponse, ARPC_ENDPOINTS, type Address, type Applicant, type ApplicationSendEmailResponse, type ArpcAuth, type ArpcConfig, type ArpcEndpoint, type ArpcEnvironment, ArpcSDK, type ArpcUrls, 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
|
|
3849
|
+
export { type ARPCErrorResponse, ARPC_ENDPOINTS, type Address, type Applicant, type ApplicationSendEmailResponse, type ArpcAuth, type ArpcConfig, type ArpcEndpoint, type ArpcEnvironment, ArpcSDK, type ArpcUrls, type AuditInfo, type BankDetails, BankDetailsAccountSubtype, BankDetailsAccountType, type BankDetailsInput, type BankUpdateRequest, type Check, CheckType, type CoApplicant, type Consents, type CreateLeadRequest, CreateLeadRequestGoalCategory, CreateLeadRequestHardshipCategory, type CreateLeadResponse, type CreditPullConsent, DRAFT_TYPE_CODE, DRAFT_TYPE_LABEL, 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, IneligibleReasonReasonId, type LeadApplicant, LeadApplicantBankruptcy, LeadApplicantEmploymentStatus, type LeadApplicantInput, LeadApplicantPayFrequency, type LeadApplication, LeadApplicationCreditPullSource, LeadApplicationDraftType, LeadApplicationFdrOrCss, LeadApplicationFixedIncome, LeadApplicationGoalCategory, LeadApplicationHardshipCategory, LeadApplicationLanguage, LeadApplicationOwnOrRent, LeadApplicationSecondaryGoal, LeadApplicationStatus, LeadApplicationSubStatus, type LeadCondition, LeadConditionActive, LeadConditionType, type LeadCreditor, type LeadDebtAccount, LeadDebtAccountAccountType, LeadDebtAccountOwnership, LeadDebtAccountResponsibility, LeadDebtAccountSource, type LeadDistribution, type LeadPatchRequest, LeadPatchRequestGoalCategory, LeadPatchRequestHardshipCategory, type LeadReadiness, type LeadResponse, type LeadTransferRequest, type LeadTransferResponse, LeadTransferResponseResponse, type MailingAddress, type PatchAddress, type PatchApplicant, type PatchCoApplicant, type PatchCondition, type PatchDebtAccount, type PaymentOption, PaymentOptionEvaluationType, type PaymentSchedule, PaymentScheduleDraftType, type PaymentScheduleOption, PaymentScheduleOptionEvaluationType, type ProgramRequest, type ProgramSelectionApplicant, type ProgramSelectionRequest, ProgramSelectionRequestDraftType, type ProgramSummaryTaskRequest, type ProgramSummaryTaskResponse, type ReadinessCheck, ReadinessCheckType, type ReadinessErrorDetail, ReadinessErrorDetailReasonCode, type ReadinessErrorResponse, type ReadinessResponse, type RegisterApplicantV2Address, type RegisterApplicantV2Request, type RegisterApplicantV2Response, type SpinwheelNetworkUserRequest, type SpinwheelNetworkUserResponse, type StatelessReadinessRequest, StatelessReadinessRequestGoalCategory, StatelessReadinessRequestHardshipCategory, type TokenCache, type Tracking, type UwSubmissionV2Response, draftTypeOf, isArpcEnvironment };
|