@borrowbetter/arpcsdk 0.2.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 +106 -12
- package/dist/index.d.mts +1154 -169
- package/dist/index.d.ts +1154 -169
- package/dist/index.js +70 -7
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +66 -8
- package/dist/index.mjs.map +1 -1
- package/package.json +2 -2
package/dist/index.d.mts
CHANGED
|
@@ -17,9 +17,8 @@ interface HttpResponse<T> {
|
|
|
17
17
|
* SDK configuration.
|
|
18
18
|
*
|
|
19
19
|
* The library never reads the environment itself — a consumer constructs
|
|
20
|
-
* `new ArpcSDK(config)`, which calls `configure()`.
|
|
21
|
-
*
|
|
22
|
-
* dotenv-flow and pass the result in.
|
|
20
|
+
* `new ArpcSDK(config)`, which calls `configure()`. Where that config comes
|
|
21
|
+
* from (env vars, a secrets manager, a config service) is the caller's business.
|
|
23
22
|
*/
|
|
24
23
|
/**
|
|
25
24
|
* Bearer-token store. The SDK authenticates lazily on the first gateway call:
|
|
@@ -35,11 +34,29 @@ interface TokenCache {
|
|
|
35
34
|
/** Persist a freshly exchanged token. `expiresAt` already includes the SDK's refresh skew. */
|
|
36
35
|
set(token: string, expiresAt: Date): Promise<void>;
|
|
37
36
|
}
|
|
38
|
-
|
|
37
|
+
/** FDR deployment target. Selects both hosts — see `ARPC_ENDPOINTS`. */
|
|
38
|
+
type ArpcEnvironment = "dev" | "stg" | "prd";
|
|
39
|
+
/** The host pair a single environment resolves to. */
|
|
40
|
+
interface ArpcEndpoint {
|
|
39
41
|
/** OAuth host — token exchange only (`POST /v1/token`). */
|
|
40
|
-
|
|
42
|
+
readonly oauth: string;
|
|
41
43
|
/** API gateway host — every non-auth call. */
|
|
42
|
-
|
|
44
|
+
readonly gateway: string;
|
|
45
|
+
}
|
|
46
|
+
/**
|
|
47
|
+
* Per-environment hosts. The two differ by domain, not just subdomain: the
|
|
48
|
+
* OAuth host is `ffngcp.com`, the gateway is `fdrgcp.com`.
|
|
49
|
+
*
|
|
50
|
+
* Frozen: this table backs both host resolution and environment validation, so
|
|
51
|
+
* a consumer mutating it would quietly change SDK behavior.
|
|
52
|
+
*/
|
|
53
|
+
declare const ARPC_ENDPOINTS: Readonly<Record<ArpcEnvironment, ArpcEndpoint>>;
|
|
54
|
+
/**
|
|
55
|
+
* Narrow a raw string to an `ArpcEnvironment`. Useful when the value arrives
|
|
56
|
+
* untyped — an env var, a JSON config file, a request payload.
|
|
57
|
+
*/
|
|
58
|
+
declare function isArpcEnvironment(value: string): value is ArpcEnvironment;
|
|
59
|
+
interface ArpcAuth {
|
|
43
60
|
/**
|
|
44
61
|
* OAuth client_id (HTTP Basic username). Also used as the lead's
|
|
45
62
|
* `seller_agent_email` — the OAuth identity is a registered DRA agent.
|
|
@@ -50,13 +67,31 @@ interface ArpcConfig {
|
|
|
50
67
|
/** Bearer-token store. Defaults to an in-memory, per-process cache. */
|
|
51
68
|
cache?: TokenCache;
|
|
52
69
|
}
|
|
70
|
+
/**
|
|
71
|
+
* Escape hatch — per-host overrides of the `environment` defaults. Omit a key
|
|
72
|
+
* (or leave it `undefined`) to keep that environment's host.
|
|
73
|
+
*/
|
|
74
|
+
interface ArpcUrls {
|
|
75
|
+
/** OAuth host — token exchange only (`POST /v1/token`). */
|
|
76
|
+
oauth?: string;
|
|
77
|
+
/** API gateway host — every non-auth call. */
|
|
78
|
+
gateway?: string;
|
|
79
|
+
}
|
|
80
|
+
interface ArpcConfig {
|
|
81
|
+
/** Selects the FDR environment. Drives both hosts. */
|
|
82
|
+
environment: ArpcEnvironment;
|
|
83
|
+
auth: ArpcAuth;
|
|
84
|
+
urls?: ArpcUrls;
|
|
85
|
+
}
|
|
53
86
|
|
|
54
87
|
/**
|
|
55
88
|
* Generated by orval v7.21.0 🍺
|
|
56
89
|
* Do not edit manually.
|
|
57
90
|
* ARPC — Achieve Resolution Partner Connect API
|
|
58
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.
|
|
59
|
-
|
|
92
|
+
|
|
93
|
+
**Published:** 2026-08-08
|
|
94
|
+
* OpenAPI spec version: 2026.16.0
|
|
60
95
|
*/
|
|
61
96
|
/**
|
|
62
97
|
* Stable machine-readable reason for the violation. See ValidationReasonCode.
|
|
@@ -76,7 +111,9 @@ declare const FieldValidationErrorReasonCode: {
|
|
|
76
111
|
* Do not edit manually.
|
|
77
112
|
* ARPC — Achieve Resolution Partner Connect API
|
|
78
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.
|
|
79
|
-
|
|
114
|
+
|
|
115
|
+
**Published:** 2026-08-08
|
|
116
|
+
* OpenAPI spec version: 2026.16.0
|
|
80
117
|
*/
|
|
81
118
|
|
|
82
119
|
/**
|
|
@@ -96,7 +133,9 @@ interface FieldValidationError {
|
|
|
96
133
|
* Do not edit manually.
|
|
97
134
|
* ARPC — Achieve Resolution Partner Connect API
|
|
98
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.
|
|
99
|
-
|
|
136
|
+
|
|
137
|
+
**Published:** 2026-08-08
|
|
138
|
+
* OpenAPI spec version: 2026.16.0
|
|
100
139
|
*/
|
|
101
140
|
|
|
102
141
|
/**
|
|
@@ -124,7 +163,9 @@ interface ARPCErrorResponse {
|
|
|
124
163
|
* Do not edit manually.
|
|
125
164
|
* ARPC — Achieve Resolution Partner Connect API
|
|
126
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.
|
|
127
|
-
|
|
166
|
+
|
|
167
|
+
**Published:** 2026-08-08
|
|
168
|
+
* OpenAPI spec version: 2026.16.0
|
|
128
169
|
*/
|
|
129
170
|
/**
|
|
130
171
|
* Street address
|
|
@@ -147,7 +188,9 @@ interface Address {
|
|
|
147
188
|
* Do not edit manually.
|
|
148
189
|
* ARPC — Achieve Resolution Partner Connect API
|
|
149
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.
|
|
150
|
-
|
|
191
|
+
|
|
192
|
+
**Published:** 2026-08-08
|
|
193
|
+
* OpenAPI spec version: 2026.16.0
|
|
151
194
|
*/
|
|
152
195
|
/**
|
|
153
196
|
* Address used by v2. ZIP is exposed as zip_code on the public request.
|
|
@@ -160,7 +203,7 @@ interface RegisterApplicantV2Address {
|
|
|
160
203
|
/** US state code — 2 characters */
|
|
161
204
|
state: string;
|
|
162
205
|
/** 5-digit ZIP code */
|
|
163
|
-
zip_code
|
|
206
|
+
zip_code: string;
|
|
164
207
|
/** Country code */
|
|
165
208
|
country?: string;
|
|
166
209
|
}
|
|
@@ -170,7 +213,9 @@ interface RegisterApplicantV2Address {
|
|
|
170
213
|
* Do not edit manually.
|
|
171
214
|
* ARPC — Achieve Resolution Partner Connect API
|
|
172
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.
|
|
173
|
-
|
|
216
|
+
|
|
217
|
+
**Published:** 2026-08-08
|
|
218
|
+
* OpenAPI spec version: 2026.16.0
|
|
174
219
|
*/
|
|
175
220
|
|
|
176
221
|
/**
|
|
@@ -188,7 +233,7 @@ interface Applicant {
|
|
|
188
233
|
/** Secondary / evening phone number (required, 10 digits) */
|
|
189
234
|
evening_phone_number: string;
|
|
190
235
|
/**
|
|
191
|
-
* 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.
|
|
192
237
|
* @pattern ^\d{9}$
|
|
193
238
|
*/
|
|
194
239
|
ssn: string;
|
|
@@ -196,7 +241,7 @@ interface Applicant {
|
|
|
196
241
|
fdr_applicant_id?: string;
|
|
197
242
|
/** Seller-assigned applicant reference ID */
|
|
198
243
|
reference_id?: string;
|
|
199
|
-
/** Date the applicant gave user consent (
|
|
244
|
+
/** Date the applicant gave user consent (YYYY-MM-DD) */
|
|
200
245
|
consent_date: string;
|
|
201
246
|
/** Applicant date of birth (YYYY-MM-DD, required) */
|
|
202
247
|
date_of_birth: string;
|
|
@@ -211,7 +256,9 @@ interface Applicant {
|
|
|
211
256
|
* Do not edit manually.
|
|
212
257
|
* ARPC — Achieve Resolution Partner Connect API
|
|
213
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.
|
|
214
|
-
|
|
259
|
+
|
|
260
|
+
**Published:** 2026-08-08
|
|
261
|
+
* OpenAPI spec version: 2026.16.0
|
|
215
262
|
*/
|
|
216
263
|
interface ApplicationSendEmailResponse {
|
|
217
264
|
status?: string;
|
|
@@ -225,7 +272,9 @@ interface ApplicationSendEmailResponse {
|
|
|
225
272
|
* Do not edit manually.
|
|
226
273
|
* ARPC — Achieve Resolution Partner Connect API
|
|
227
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.
|
|
228
|
-
|
|
275
|
+
|
|
276
|
+
**Published:** 2026-08-08
|
|
277
|
+
* OpenAPI spec version: 2026.16.0
|
|
229
278
|
*/
|
|
230
279
|
/**
|
|
231
280
|
* Audit metadata
|
|
@@ -240,7 +289,45 @@ interface AuditInfo {
|
|
|
240
289
|
* Do not edit manually.
|
|
241
290
|
* ARPC — Achieve Resolution Partner Connect API
|
|
242
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.
|
|
243
|
-
|
|
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
|
|
244
331
|
*/
|
|
245
332
|
|
|
246
333
|
/**
|
|
@@ -251,9 +338,9 @@ type BankDetails = {
|
|
|
251
338
|
/** Bank name */
|
|
252
339
|
name?: string;
|
|
253
340
|
/** Account type */
|
|
254
|
-
account_type?:
|
|
341
|
+
account_type?: BankDetailsAccountType;
|
|
255
342
|
/** Account sub-type */
|
|
256
|
-
account_subtype?:
|
|
343
|
+
account_subtype?: BankDetailsAccountSubtype;
|
|
257
344
|
/** Bank account number */
|
|
258
345
|
account_number?: string;
|
|
259
346
|
/** Bank routing number */
|
|
@@ -280,7 +367,9 @@ type BankDetails = {
|
|
|
280
367
|
* Do not edit manually.
|
|
281
368
|
* ARPC — Achieve Resolution Partner Connect API
|
|
282
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.
|
|
283
|
-
|
|
370
|
+
|
|
371
|
+
**Published:** 2026-08-08
|
|
372
|
+
* OpenAPI spec version: 2026.16.0
|
|
284
373
|
*/
|
|
285
374
|
/**
|
|
286
375
|
* Bank account input fields
|
|
@@ -297,7 +386,9 @@ interface BankDetailsInput {
|
|
|
297
386
|
* Do not edit manually.
|
|
298
387
|
* ARPC — Achieve Resolution Partner Connect API
|
|
299
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.
|
|
300
|
-
|
|
389
|
+
|
|
390
|
+
**Published:** 2026-08-08
|
|
391
|
+
* OpenAPI spec version: 2026.16.0
|
|
301
392
|
*/
|
|
302
393
|
|
|
303
394
|
/**
|
|
@@ -316,7 +407,9 @@ interface BankUpdateRequest {
|
|
|
316
407
|
* Do not edit manually.
|
|
317
408
|
* ARPC — Achieve Resolution Partner Connect API
|
|
318
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.
|
|
319
|
-
|
|
410
|
+
|
|
411
|
+
**Published:** 2026-08-08
|
|
412
|
+
* OpenAPI spec version: 2026.16.0
|
|
320
413
|
*/
|
|
321
414
|
/**
|
|
322
415
|
* Check type identifier
|
|
@@ -332,7 +425,9 @@ declare const CheckType: {
|
|
|
332
425
|
* Do not edit manually.
|
|
333
426
|
* ARPC — Achieve Resolution Partner Connect API
|
|
334
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.
|
|
335
|
-
|
|
428
|
+
|
|
429
|
+
**Published:** 2026-08-08
|
|
430
|
+
* OpenAPI spec version: 2026.16.0
|
|
336
431
|
*/
|
|
337
432
|
|
|
338
433
|
/**
|
|
@@ -355,7 +450,9 @@ interface Check {
|
|
|
355
450
|
* Do not edit manually.
|
|
356
451
|
* ARPC — Achieve Resolution Partner Connect API
|
|
357
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.
|
|
358
|
-
|
|
453
|
+
|
|
454
|
+
**Published:** 2026-08-08
|
|
455
|
+
* OpenAPI spec version: 2026.16.0
|
|
359
456
|
*/
|
|
360
457
|
|
|
361
458
|
/**
|
|
@@ -423,7 +520,9 @@ interface CoApplicant {
|
|
|
423
520
|
* Do not edit manually.
|
|
424
521
|
* ARPC — Achieve Resolution Partner Connect API
|
|
425
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.
|
|
426
|
-
|
|
523
|
+
|
|
524
|
+
**Published:** 2026-08-08
|
|
525
|
+
* OpenAPI spec version: 2026.16.0
|
|
427
526
|
*/
|
|
428
527
|
/**
|
|
429
528
|
* Required consent strings for regulatory and platform compliance
|
|
@@ -446,7 +545,9 @@ interface Consents {
|
|
|
446
545
|
* Do not edit manually.
|
|
447
546
|
* ARPC — Achieve Resolution Partner Connect API
|
|
448
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.
|
|
449
|
-
|
|
548
|
+
|
|
549
|
+
**Published:** 2026-08-08
|
|
550
|
+
* OpenAPI spec version: 2026.16.0
|
|
450
551
|
*/
|
|
451
552
|
/**
|
|
452
553
|
* Lead distribution routing configuration
|
|
@@ -463,7 +564,51 @@ interface LeadDistribution {
|
|
|
463
564
|
* Do not edit manually.
|
|
464
565
|
* ARPC — Achieve Resolution Partner Connect API
|
|
465
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.
|
|
466
|
-
|
|
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
|
|
467
612
|
*/
|
|
468
613
|
|
|
469
614
|
/**
|
|
@@ -541,7 +686,9 @@ interface LeadApplicantInput {
|
|
|
541
686
|
* Do not edit manually.
|
|
542
687
|
* ARPC — Achieve Resolution Partner Connect API
|
|
543
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.
|
|
544
|
-
|
|
689
|
+
|
|
690
|
+
**Published:** 2026-08-08
|
|
691
|
+
* OpenAPI spec version: 2026.16.0
|
|
545
692
|
*/
|
|
546
693
|
/**
|
|
547
694
|
* Whether the condition is currently active
|
|
@@ -557,7 +704,29 @@ declare const LeadConditionActive: {
|
|
|
557
704
|
* Do not edit manually.
|
|
558
705
|
* ARPC — Achieve Resolution Partner Connect API
|
|
559
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.
|
|
560
|
-
|
|
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
|
|
561
730
|
*/
|
|
562
731
|
|
|
563
732
|
/**
|
|
@@ -572,7 +741,7 @@ type LeadCondition = {
|
|
|
572
741
|
/** Whether the condition is currently active */
|
|
573
742
|
active?: LeadConditionActive;
|
|
574
743
|
/** Condition type. soft-condition types omit the verified field in the response. */
|
|
575
|
-
type?:
|
|
744
|
+
type?: LeadConditionType;
|
|
576
745
|
/**
|
|
577
746
|
* Whether the condition has been verified by underwriting. Absent for soft-condition type.
|
|
578
747
|
* @nullable
|
|
@@ -594,7 +763,9 @@ type LeadCondition = {
|
|
|
594
763
|
* Do not edit manually.
|
|
595
764
|
* ARPC — Achieve Resolution Partner Connect API
|
|
596
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.
|
|
597
|
-
|
|
766
|
+
|
|
767
|
+
**Published:** 2026-08-08
|
|
768
|
+
* OpenAPI spec version: 2026.16.0
|
|
598
769
|
*/
|
|
599
770
|
|
|
600
771
|
/**
|
|
@@ -672,7 +843,9 @@ interface DebtAccount {
|
|
|
672
843
|
* Do not edit manually.
|
|
673
844
|
* ARPC — Achieve Resolution Partner Connect API
|
|
674
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.
|
|
675
|
-
|
|
846
|
+
|
|
847
|
+
**Published:** 2026-08-08
|
|
848
|
+
* OpenAPI spec version: 2026.16.0
|
|
676
849
|
*/
|
|
677
850
|
|
|
678
851
|
/**
|
|
@@ -774,12 +947,12 @@ interface CreateLeadRequest {
|
|
|
774
947
|
transportation_expenses?: number;
|
|
775
948
|
/** Other miscellaneous monthly expenses (USD) */
|
|
776
949
|
other_expenses_describe?: number;
|
|
777
|
-
/** Primary hardship category
|
|
778
|
-
hardship_category?:
|
|
950
|
+
/** Primary hardship category */
|
|
951
|
+
hardship_category?: CreateLeadRequestHardshipCategory;
|
|
779
952
|
/** Free-text description when hardship category is 'other' */
|
|
780
953
|
hardship_category_other?: string;
|
|
781
|
-
/** Primary goal category
|
|
782
|
-
goal_category?:
|
|
954
|
+
/** Primary goal category */
|
|
955
|
+
goal_category?: CreateLeadRequestGoalCategory;
|
|
783
956
|
/** Free-text description when goal category is 'other' */
|
|
784
957
|
goal_category_other?: string;
|
|
785
958
|
/** Next paycheck date (YYYY-MM-DD) */
|
|
@@ -818,17 +991,88 @@ interface CreateLeadRequest {
|
|
|
818
991
|
* Do not edit manually.
|
|
819
992
|
* ARPC — Achieve Resolution Partner Connect API
|
|
820
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.
|
|
821
|
-
|
|
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
|
|
822
1063
|
*/
|
|
823
1064
|
/**
|
|
824
1065
|
* Pay frequency
|
|
825
1066
|
*/
|
|
826
1067
|
type LeadApplicantPayFrequency = typeof LeadApplicantPayFrequency[keyof typeof LeadApplicantPayFrequency];
|
|
827
1068
|
declare const LeadApplicantPayFrequency: {
|
|
1069
|
+
readonly none: "none";
|
|
828
1070
|
readonly weekly: "weekly";
|
|
829
1071
|
readonly 'bi-weekly': "bi-weekly";
|
|
830
|
-
readonly
|
|
831
|
-
readonly
|
|
1072
|
+
readonly split: "split";
|
|
1073
|
+
readonly regular: "regular";
|
|
1074
|
+
readonly irregular: "irregular";
|
|
1075
|
+
readonly unknown: "unknown";
|
|
832
1076
|
};
|
|
833
1077
|
|
|
834
1078
|
/**
|
|
@@ -836,7 +1080,9 @@ declare const LeadApplicantPayFrequency: {
|
|
|
836
1080
|
* Do not edit manually.
|
|
837
1081
|
* ARPC — Achieve Resolution Partner Connect API
|
|
838
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.
|
|
839
|
-
|
|
1083
|
+
|
|
1084
|
+
**Published:** 2026-08-08
|
|
1085
|
+
* OpenAPI spec version: 2026.16.0
|
|
840
1086
|
*/
|
|
841
1087
|
/**
|
|
842
1088
|
* Current employment status
|
|
@@ -846,7 +1092,7 @@ declare const LeadApplicantEmploymentStatus: {
|
|
|
846
1092
|
readonly 'Full-Time': "Full-Time";
|
|
847
1093
|
readonly 'Part-Time': "Part-Time";
|
|
848
1094
|
readonly 'Self-Employed': "Self-Employed";
|
|
849
|
-
readonly
|
|
1095
|
+
readonly Not_Employed: "Not Employed";
|
|
850
1096
|
readonly Retired: "Retired";
|
|
851
1097
|
readonly Other: "Other";
|
|
852
1098
|
};
|
|
@@ -856,7 +1102,9 @@ declare const LeadApplicantEmploymentStatus: {
|
|
|
856
1102
|
* Do not edit manually.
|
|
857
1103
|
* ARPC — Achieve Resolution Partner Connect API
|
|
858
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.
|
|
859
|
-
|
|
1105
|
+
|
|
1106
|
+
**Published:** 2026-08-08
|
|
1107
|
+
* OpenAPI spec version: 2026.16.0
|
|
860
1108
|
*/
|
|
861
1109
|
|
|
862
1110
|
/**
|
|
@@ -879,7 +1127,7 @@ type LeadApplicant = {
|
|
|
879
1127
|
/** Monthly unemployment income (USD) */
|
|
880
1128
|
unemployment?: number;
|
|
881
1129
|
/** Bankruptcy status on file */
|
|
882
|
-
bankruptcy?:
|
|
1130
|
+
bankruptcy?: LeadApplicantBankruptcy;
|
|
883
1131
|
/**
|
|
884
1132
|
* Conditions associated with this applicant
|
|
885
1133
|
* @nullable
|
|
@@ -955,7 +1203,79 @@ type LeadApplicant = {
|
|
|
955
1203
|
* Do not edit manually.
|
|
956
1204
|
* ARPC — Achieve Resolution Partner Connect API
|
|
957
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.
|
|
958
|
-
|
|
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
|
|
959
1279
|
*/
|
|
960
1280
|
/**
|
|
961
1281
|
* Indicates whether the program is FDR or CSS serviced
|
|
@@ -971,7 +1291,30 @@ declare const LeadApplicationFdrOrCss: {
|
|
|
971
1291
|
* Do not edit manually.
|
|
972
1292
|
* ARPC — Achieve Resolution Partner Connect API
|
|
973
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.
|
|
974
|
-
|
|
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
|
|
975
1318
|
*/
|
|
976
1319
|
/**
|
|
977
1320
|
* Whether client is on fixed income. Salesforce returns this as the string \"Yes\" or \"No\" (not a boolean).
|
|
@@ -987,7 +1330,9 @@ declare const LeadApplicationFixedIncome: {
|
|
|
987
1330
|
* Do not edit manually.
|
|
988
1331
|
* ARPC — Achieve Resolution Partner Connect API
|
|
989
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.
|
|
990
|
-
|
|
1333
|
+
|
|
1334
|
+
**Published:** 2026-08-08
|
|
1335
|
+
* OpenAPI spec version: 2026.16.0
|
|
991
1336
|
*/
|
|
992
1337
|
/**
|
|
993
1338
|
* Whether the client owns or rents their home
|
|
@@ -1003,7 +1348,75 @@ declare const LeadApplicationOwnOrRent: {
|
|
|
1003
1348
|
* Do not edit manually.
|
|
1004
1349
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1005
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.
|
|
1006
|
-
|
|
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
|
|
1007
1420
|
*/
|
|
1008
1421
|
/**
|
|
1009
1422
|
* Source of the credit report pull (also present inside applicant)
|
|
@@ -1019,7 +1432,9 @@ declare const LeadApplicationCreditPullSource: {
|
|
|
1019
1432
|
* Do not edit manually.
|
|
1020
1433
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1021
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.
|
|
1022
|
-
|
|
1435
|
+
|
|
1436
|
+
**Published:** 2026-08-08
|
|
1437
|
+
* OpenAPI spec version: 2026.16.0
|
|
1023
1438
|
*/
|
|
1024
1439
|
/**
|
|
1025
1440
|
* Creditor or original creditor details
|
|
@@ -1056,7 +1471,9 @@ interface LeadCreditor {
|
|
|
1056
1471
|
* Do not edit manually.
|
|
1057
1472
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1058
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.
|
|
1059
|
-
|
|
1474
|
+
|
|
1475
|
+
**Published:** 2026-08-08
|
|
1476
|
+
* OpenAPI spec version: 2026.16.0
|
|
1060
1477
|
*/
|
|
1061
1478
|
/**
|
|
1062
1479
|
* Responsibility type for the account
|
|
@@ -1066,6 +1483,13 @@ declare const LeadDebtAccountResponsibility: {
|
|
|
1066
1483
|
readonly individual: "individual";
|
|
1067
1484
|
readonly joint: "joint";
|
|
1068
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";
|
|
1069
1493
|
};
|
|
1070
1494
|
|
|
1071
1495
|
/**
|
|
@@ -1073,7 +1497,9 @@ declare const LeadDebtAccountResponsibility: {
|
|
|
1073
1497
|
* Do not edit manually.
|
|
1074
1498
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1075
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.
|
|
1076
|
-
|
|
1500
|
+
|
|
1501
|
+
**Published:** 2026-08-08
|
|
1502
|
+
* OpenAPI spec version: 2026.16.0
|
|
1077
1503
|
*/
|
|
1078
1504
|
/**
|
|
1079
1505
|
* Ownership of the account
|
|
@@ -1090,15 +1516,114 @@ declare const LeadDebtAccountOwnership: {
|
|
|
1090
1516
|
* Do not edit manually.
|
|
1091
1517
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1092
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.
|
|
1093
|
-
|
|
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
|
|
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
|
|
1094
1618
|
*/
|
|
1619
|
+
|
|
1095
1620
|
/**
|
|
1096
1621
|
* Ineligibility reason code wrapper
|
|
1097
1622
|
* @nullable
|
|
1098
1623
|
*/
|
|
1099
1624
|
type IneligibleReason = {
|
|
1100
|
-
/** Ineligibility reason identifier */
|
|
1101
|
-
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;
|
|
1102
1627
|
} | null;
|
|
1103
1628
|
|
|
1104
1629
|
/**
|
|
@@ -1106,7 +1631,9 @@ type IneligibleReason = {
|
|
|
1106
1631
|
* Do not edit manually.
|
|
1107
1632
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1108
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.
|
|
1109
|
-
|
|
1634
|
+
|
|
1635
|
+
**Published:** 2026-08-08
|
|
1636
|
+
* OpenAPI spec version: 2026.16.0
|
|
1110
1637
|
*/
|
|
1111
1638
|
|
|
1112
1639
|
/**
|
|
@@ -1127,7 +1654,7 @@ interface LeadDebtAccount {
|
|
|
1127
1654
|
/** Ownership of the account */
|
|
1128
1655
|
ownership?: LeadDebtAccountOwnership;
|
|
1129
1656
|
/** Source of the debt account record */
|
|
1130
|
-
source?:
|
|
1657
|
+
source?: LeadDebtAccountSource;
|
|
1131
1658
|
/** Age / delinquency bucket of the debt */
|
|
1132
1659
|
aging?: string;
|
|
1133
1660
|
/** Rank assigned by DebtAccountRankingUtil (lower = higher priority) */
|
|
@@ -1166,7 +1693,7 @@ interface LeadDebtAccount {
|
|
|
1166
1693
|
/** Whether the account is active */
|
|
1167
1694
|
is_active?: string;
|
|
1168
1695
|
/** Type of account */
|
|
1169
|
-
account_type?:
|
|
1696
|
+
account_type?: LeadDebtAccountAccountType;
|
|
1170
1697
|
/** Sub-type of the account */
|
|
1171
1698
|
sub_account_type?: string;
|
|
1172
1699
|
/** Condition of the account */
|
|
@@ -1201,6 +1728,16 @@ interface LeadDebtAccount {
|
|
|
1201
1728
|
credit_utilization?: string;
|
|
1202
1729
|
/** Most recent delinquency bucket reported */
|
|
1203
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;
|
|
1204
1741
|
/** First name of the joint account holder, if applicable */
|
|
1205
1742
|
joint_holder_first_name?: string;
|
|
1206
1743
|
/** Last name of the joint account holder, if applicable */
|
|
@@ -1225,19 +1762,136 @@ interface LeadDebtAccount {
|
|
|
1225
1762
|
* Do not edit manually.
|
|
1226
1763
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1227
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.
|
|
1228
|
-
|
|
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
|
|
1229
1859
|
*/
|
|
1230
1860
|
/**
|
|
1231
|
-
*
|
|
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
|
|
1232
1882
|
* @nullable
|
|
1233
1883
|
*/
|
|
1234
|
-
type
|
|
1235
|
-
/**
|
|
1236
|
-
|
|
1237
|
-
/**
|
|
1238
|
-
|
|
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;
|
|
1239
1891
|
/** Program length for this option (months) */
|
|
1240
1892
|
program_length?: number;
|
|
1893
|
+
/** Total program cost for this option (USD) */
|
|
1894
|
+
program_cost?: number;
|
|
1241
1895
|
} | null;
|
|
1242
1896
|
|
|
1243
1897
|
/**
|
|
@@ -1245,7 +1899,9 @@ type PaymentOption = {
|
|
|
1245
1899
|
* Do not edit manually.
|
|
1246
1900
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1247
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.
|
|
1248
|
-
|
|
1902
|
+
|
|
1903
|
+
**Published:** 2026-08-08
|
|
1904
|
+
* OpenAPI spec version: 2026.16.0
|
|
1249
1905
|
*/
|
|
1250
1906
|
|
|
1251
1907
|
/**
|
|
@@ -1253,11 +1909,11 @@ type PaymentOption = {
|
|
|
1253
1909
|
*/
|
|
1254
1910
|
interface LeadApplication {
|
|
1255
1911
|
/** Current program / opportunity stage */
|
|
1256
|
-
status?:
|
|
1912
|
+
status?: LeadApplicationStatus;
|
|
1257
1913
|
/** Program lifecycle state (e.g. Active, Closed, Cancelled) */
|
|
1258
1914
|
state?: string;
|
|
1259
1915
|
/** Client's preferred language */
|
|
1260
|
-
language?:
|
|
1916
|
+
language?: LeadApplicationLanguage;
|
|
1261
1917
|
/**
|
|
1262
1918
|
* Whether this application passed program eligibility checks
|
|
1263
1919
|
* @nullable
|
|
@@ -1278,7 +1934,7 @@ interface LeadApplication {
|
|
|
1278
1934
|
*/
|
|
1279
1935
|
conditions?: LeadCondition[] | null;
|
|
1280
1936
|
/** Sub-status of the current stage */
|
|
1281
|
-
sub_status?:
|
|
1937
|
+
sub_status?: LeadApplicationSubStatus;
|
|
1282
1938
|
/**
|
|
1283
1939
|
* DEX-specific flow status set by the partner integration
|
|
1284
1940
|
* @nullable
|
|
@@ -1374,8 +2030,10 @@ interface LeadApplication {
|
|
|
1374
2030
|
savings_vs_enrolled_debt?: number;
|
|
1375
2031
|
/** Monthly draft amount (USD) */
|
|
1376
2032
|
draft_amount?: number;
|
|
1377
|
-
/** Draft frequency type
|
|
1378
|
-
|
|
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;
|
|
1379
2037
|
/** Date of first programme draft (YYYY-MM-DD) */
|
|
1380
2038
|
first_draft_date?: string;
|
|
1381
2039
|
/** Second draft date for bi-weekly drafts (YYYY-MM-DD) */
|
|
@@ -1439,21 +2097,21 @@ interface LeadApplication {
|
|
|
1439
2097
|
/** Other expenses amount (numeric) */
|
|
1440
2098
|
other_expenses_describe?: number;
|
|
1441
2099
|
/** Primary hardship category */
|
|
1442
|
-
hardship_category?:
|
|
2100
|
+
hardship_category?: LeadApplicationHardshipCategory;
|
|
1443
2101
|
/**
|
|
1444
2102
|
* Free-text hardship description when category is 'Other'
|
|
1445
2103
|
* @nullable
|
|
1446
2104
|
*/
|
|
1447
2105
|
hardship_category_other?: string | null;
|
|
1448
2106
|
/** Client's primary financial goal category */
|
|
1449
|
-
goal_category?:
|
|
2107
|
+
goal_category?: LeadApplicationGoalCategory;
|
|
1450
2108
|
/**
|
|
1451
2109
|
* Free-text goal when category is 'Other'
|
|
1452
2110
|
* @nullable
|
|
1453
2111
|
*/
|
|
1454
2112
|
goal_category_other?: string | null;
|
|
1455
2113
|
/** Client's secondary financial goal */
|
|
1456
|
-
secondary_goal?:
|
|
2114
|
+
secondary_goal?: LeadApplicationSecondaryGoal;
|
|
1457
2115
|
/** Justification for housing cost amount */
|
|
1458
2116
|
housing_justification?: string;
|
|
1459
2117
|
/** Justification for transportation cost amount */
|
|
@@ -1561,6 +2219,11 @@ interface LeadApplication {
|
|
|
1561
2219
|
* @nullable
|
|
1562
2220
|
*/
|
|
1563
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;
|
|
1564
2227
|
bank_details?: BankDetails;
|
|
1565
2228
|
/**
|
|
1566
2229
|
* Reasons the application is ineligible, if any. Normalised from a comma-separated string to an array of reason objects.
|
|
@@ -1574,7 +2237,9 @@ interface LeadApplication {
|
|
|
1574
2237
|
* Do not edit manually.
|
|
1575
2238
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1576
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.
|
|
1577
|
-
|
|
2240
|
+
|
|
2241
|
+
**Published:** 2026-08-08
|
|
2242
|
+
* OpenAPI spec version: 2026.16.0
|
|
1578
2243
|
*/
|
|
1579
2244
|
|
|
1580
2245
|
/**
|
|
@@ -1595,7 +2260,9 @@ interface CreateLeadResponse {
|
|
|
1595
2260
|
* Do not edit manually.
|
|
1596
2261
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1597
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.
|
|
1598
|
-
|
|
2263
|
+
|
|
2264
|
+
**Published:** 2026-08-08
|
|
2265
|
+
* OpenAPI spec version: 2026.16.0
|
|
1599
2266
|
*/
|
|
1600
2267
|
/**
|
|
1601
2268
|
* Consent record for soft credit pull
|
|
@@ -1611,7 +2278,9 @@ type CreditPullConsent = {
|
|
|
1611
2278
|
* Do not edit manually.
|
|
1612
2279
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1613
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.
|
|
1614
|
-
|
|
2281
|
+
|
|
2282
|
+
**Published:** 2026-08-08
|
|
2283
|
+
* OpenAPI spec version: 2026.16.0
|
|
1615
2284
|
*/
|
|
1616
2285
|
/**
|
|
1617
2286
|
* Applicant signing URL details
|
|
@@ -1626,7 +2295,9 @@ interface DraApplicant {
|
|
|
1626
2295
|
* Do not edit manually.
|
|
1627
2296
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1628
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.
|
|
1629
|
-
|
|
2298
|
+
|
|
2299
|
+
**Published:** 2026-08-08
|
|
2300
|
+
* OpenAPI spec version: 2026.16.0
|
|
1630
2301
|
*/
|
|
1631
2302
|
/**
|
|
1632
2303
|
* DocuSign signing method. Use 'url' for embedded signing, 'email' for standard email signing.
|
|
@@ -1642,7 +2313,9 @@ declare const DraApplicantInputSigningType: {
|
|
|
1642
2313
|
* Do not edit manually.
|
|
1643
2314
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1644
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.
|
|
1645
|
-
|
|
2316
|
+
|
|
2317
|
+
**Published:** 2026-08-08
|
|
2318
|
+
* OpenAPI spec version: 2026.16.0
|
|
1646
2319
|
*/
|
|
1647
2320
|
|
|
1648
2321
|
/**
|
|
@@ -1658,7 +2331,9 @@ interface DraApplicantInput {
|
|
|
1658
2331
|
* Do not edit manually.
|
|
1659
2332
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1660
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.
|
|
1661
|
-
|
|
2334
|
+
|
|
2335
|
+
**Published:** 2026-08-08
|
|
2336
|
+
* OpenAPI spec version: 2026.16.0
|
|
1662
2337
|
*/
|
|
1663
2338
|
|
|
1664
2339
|
/**
|
|
@@ -1675,7 +2350,9 @@ interface DraRequest {
|
|
|
1675
2350
|
* Do not edit manually.
|
|
1676
2351
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1677
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.
|
|
1678
|
-
|
|
2353
|
+
|
|
2354
|
+
**Published:** 2026-08-08
|
|
2355
|
+
* OpenAPI spec version: 2026.16.0
|
|
1679
2356
|
*/
|
|
1680
2357
|
|
|
1681
2358
|
/**
|
|
@@ -1692,7 +2369,9 @@ interface DraResponse {
|
|
|
1692
2369
|
* Do not edit manually.
|
|
1693
2370
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1694
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.
|
|
1695
|
-
|
|
2372
|
+
|
|
2373
|
+
**Published:** 2026-08-08
|
|
2374
|
+
* OpenAPI spec version: 2026.16.0
|
|
1696
2375
|
*/
|
|
1697
2376
|
/**
|
|
1698
2377
|
* Address for eligibility request
|
|
@@ -1715,7 +2394,9 @@ interface EligibilityAddress {
|
|
|
1715
2394
|
* Do not edit manually.
|
|
1716
2395
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1717
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.
|
|
1718
|
-
|
|
2397
|
+
|
|
2398
|
+
**Published:** 2026-08-08
|
|
2399
|
+
* OpenAPI spec version: 2026.16.0
|
|
1719
2400
|
*/
|
|
1720
2401
|
|
|
1721
2402
|
/**
|
|
@@ -1742,7 +2423,9 @@ interface EligibilityApplicant {
|
|
|
1742
2423
|
* Do not edit manually.
|
|
1743
2424
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1744
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.
|
|
1745
|
-
|
|
2426
|
+
|
|
2427
|
+
**Published:** 2026-08-08
|
|
2428
|
+
* OpenAPI spec version: 2026.16.0
|
|
1746
2429
|
*/
|
|
1747
2430
|
|
|
1748
2431
|
/**
|
|
@@ -1754,6 +2437,11 @@ interface EligibilityApplication {
|
|
|
1754
2437
|
debt_accounts?: LeadDebtAccount[];
|
|
1755
2438
|
/** Selectable payment options (3 tiers) */
|
|
1756
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;
|
|
1757
2445
|
/** Total enrolled debt (USD) */
|
|
1758
2446
|
estimated_total_debt?: number;
|
|
1759
2447
|
/** Total cost if no action taken (USD) */
|
|
@@ -1821,7 +2509,9 @@ interface EligibilityApplication {
|
|
|
1821
2509
|
* Do not edit manually.
|
|
1822
2510
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1823
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.
|
|
1824
|
-
|
|
2512
|
+
|
|
2513
|
+
**Published:** 2026-08-08
|
|
2514
|
+
* OpenAPI spec version: 2026.16.0
|
|
1825
2515
|
*/
|
|
1826
2516
|
/**
|
|
1827
2517
|
* Debt account entry for eligibility check (no-credit-pull path)
|
|
@@ -1861,7 +2551,9 @@ type EligibilityDebtAccount = {
|
|
|
1861
2551
|
* Do not edit manually.
|
|
1862
2552
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1863
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.
|
|
1864
|
-
|
|
2554
|
+
|
|
2555
|
+
**Published:** 2026-08-08
|
|
2556
|
+
* OpenAPI spec version: 2026.16.0
|
|
1865
2557
|
*/
|
|
1866
2558
|
|
|
1867
2559
|
/**
|
|
@@ -1883,7 +2575,9 @@ interface EligibilityRequest {
|
|
|
1883
2575
|
* Do not edit manually.
|
|
1884
2576
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1885
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.
|
|
1886
|
-
|
|
2578
|
+
|
|
2579
|
+
**Published:** 2026-08-08
|
|
2580
|
+
* OpenAPI spec version: 2026.16.0
|
|
1887
2581
|
*/
|
|
1888
2582
|
|
|
1889
2583
|
/**
|
|
@@ -1902,15 +2596,46 @@ interface EligibilityResponse {
|
|
|
1902
2596
|
* Do not edit manually.
|
|
1903
2597
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1904
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.
|
|
1905
|
-
|
|
2599
|
+
|
|
2600
|
+
**Published:** 2026-08-08
|
|
2601
|
+
* OpenAPI spec version: 2026.16.0
|
|
1906
2602
|
*/
|
|
1907
2603
|
/**
|
|
1908
|
-
*
|
|
2604
|
+
* Check type identifier
|
|
1909
2605
|
*/
|
|
1910
2606
|
type ReadinessCheckType = typeof ReadinessCheckType[keyof typeof ReadinessCheckType];
|
|
1911
2607
|
declare const ReadinessCheckType: {
|
|
2608
|
+
readonly lead: "lead";
|
|
1912
2609
|
readonly uw_submission: "uw_submission";
|
|
1913
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";
|
|
1914
2639
|
};
|
|
1915
2640
|
|
|
1916
2641
|
/**
|
|
@@ -1918,19 +2643,55 @@ declare const ReadinessCheckType: {
|
|
|
1918
2643
|
* Do not edit manually.
|
|
1919
2644
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1920
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.
|
|
1921
|
-
|
|
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
|
|
1922
2675
|
*/
|
|
1923
2676
|
|
|
1924
2677
|
/**
|
|
1925
|
-
*
|
|
2678
|
+
* Individual readiness check result
|
|
1926
2679
|
*/
|
|
1927
2680
|
interface ReadinessCheck {
|
|
1928
|
-
/**
|
|
2681
|
+
/** Check type identifier */
|
|
1929
2682
|
type?: ReadinessCheckType;
|
|
1930
|
-
/** Whether this
|
|
2683
|
+
/** Whether this check passed */
|
|
1931
2684
|
verified?: boolean;
|
|
1932
|
-
/**
|
|
1933
|
-
|
|
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;
|
|
1934
2695
|
}
|
|
1935
2696
|
|
|
1936
2697
|
/**
|
|
@@ -1938,11 +2699,15 @@ interface ReadinessCheck {
|
|
|
1938
2699
|
* Do not edit manually.
|
|
1939
2700
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1940
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.
|
|
1941
|
-
|
|
2702
|
+
|
|
2703
|
+
**Published:** 2026-08-08
|
|
2704
|
+
* OpenAPI spec version: 2026.16.0
|
|
1942
2705
|
*/
|
|
1943
2706
|
|
|
1944
2707
|
/**
|
|
1945
|
-
* 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.
|
|
1946
2711
|
*/
|
|
1947
2712
|
interface ErrorDetails {
|
|
1948
2713
|
/** Per-gate check results */
|
|
@@ -1951,6 +2716,8 @@ interface ErrorDetails {
|
|
|
1951
2716
|
is_program_refresh_required?: boolean;
|
|
1952
2717
|
/** Whether the application is currently UW-approved */
|
|
1953
2718
|
is_uw_approved?: boolean;
|
|
2719
|
+
/** Human-readable summary of the gate failure */
|
|
2720
|
+
message?: string;
|
|
1954
2721
|
}
|
|
1955
2722
|
|
|
1956
2723
|
/**
|
|
@@ -1958,7 +2725,9 @@ interface ErrorDetails {
|
|
|
1958
2725
|
* Do not edit manually.
|
|
1959
2726
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1960
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.
|
|
1961
|
-
|
|
2728
|
+
|
|
2729
|
+
**Published:** 2026-08-08
|
|
2730
|
+
* OpenAPI spec version: 2026.16.0
|
|
1962
2731
|
*/
|
|
1963
2732
|
/**
|
|
1964
2733
|
* Address — used for current and mailing address updates
|
|
@@ -1981,7 +2750,9 @@ interface PatchAddress {
|
|
|
1981
2750
|
* Do not edit manually.
|
|
1982
2751
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1983
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.
|
|
1984
|
-
|
|
2753
|
+
|
|
2754
|
+
**Published:** 2026-08-08
|
|
2755
|
+
* OpenAPI spec version: 2026.16.0
|
|
1985
2756
|
*/
|
|
1986
2757
|
|
|
1987
2758
|
/**
|
|
@@ -2051,7 +2822,51 @@ interface PatchApplicant {
|
|
|
2051
2822
|
* Do not edit manually.
|
|
2052
2823
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2053
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.
|
|
2054
|
-
|
|
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
|
|
2055
2870
|
*/
|
|
2056
2871
|
/**
|
|
2057
2872
|
* Condition to verify (lead-level or debt-account-level)
|
|
@@ -2070,7 +2885,9 @@ interface PatchCondition {
|
|
|
2070
2885
|
* Do not edit manually.
|
|
2071
2886
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2072
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.
|
|
2073
|
-
|
|
2888
|
+
|
|
2889
|
+
**Published:** 2026-08-08
|
|
2890
|
+
* OpenAPI spec version: 2026.16.0
|
|
2074
2891
|
*/
|
|
2075
2892
|
|
|
2076
2893
|
/**
|
|
@@ -2092,7 +2909,9 @@ interface PatchDebtAccount {
|
|
|
2092
2909
|
* Do not edit manually.
|
|
2093
2910
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2094
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.
|
|
2095
|
-
|
|
2912
|
+
|
|
2913
|
+
**Published:** 2026-08-08
|
|
2914
|
+
* OpenAPI spec version: 2026.16.0
|
|
2096
2915
|
*/
|
|
2097
2916
|
/**
|
|
2098
2917
|
* Co-applicant fields that can be patched
|
|
@@ -2151,7 +2970,9 @@ interface PatchCoApplicant {
|
|
|
2151
2970
|
* Do not edit manually.
|
|
2152
2971
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2153
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.
|
|
2154
|
-
|
|
2973
|
+
|
|
2974
|
+
**Published:** 2026-08-08
|
|
2975
|
+
* OpenAPI spec version: 2026.16.0
|
|
2155
2976
|
*/
|
|
2156
2977
|
|
|
2157
2978
|
/**
|
|
@@ -2166,11 +2987,11 @@ interface LeadPatchRequest {
|
|
|
2166
2987
|
/** Desired monthly deposit amount */
|
|
2167
2988
|
monthly_deposit?: number;
|
|
2168
2989
|
/** Hardship category */
|
|
2169
|
-
hardship_category?:
|
|
2990
|
+
hardship_category?: LeadPatchRequestHardshipCategory;
|
|
2170
2991
|
/** Free-text hardship description when category is 'Other' */
|
|
2171
2992
|
hardship_category_other?: string;
|
|
2172
2993
|
/** Goal category */
|
|
2173
|
-
goal_category?:
|
|
2994
|
+
goal_category?: LeadPatchRequestGoalCategory;
|
|
2174
2995
|
/** Free-text goal description when category is 'Other' */
|
|
2175
2996
|
goal_category_other?: string;
|
|
2176
2997
|
/** Monthly food expenses */
|
|
@@ -2251,7 +3072,9 @@ interface LeadPatchRequest {
|
|
|
2251
3072
|
* Do not edit manually.
|
|
2252
3073
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2253
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.
|
|
2254
|
-
|
|
3075
|
+
|
|
3076
|
+
**Published:** 2026-08-08
|
|
3077
|
+
* OpenAPI spec version: 2026.16.0
|
|
2255
3078
|
*/
|
|
2256
3079
|
|
|
2257
3080
|
/**
|
|
@@ -2278,7 +3101,9 @@ type LeadReadiness = {
|
|
|
2278
3101
|
* Do not edit manually.
|
|
2279
3102
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2280
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.
|
|
2281
|
-
|
|
3104
|
+
|
|
3105
|
+
**Published:** 2026-08-08
|
|
3106
|
+
* OpenAPI spec version: 2026.16.0
|
|
2282
3107
|
*/
|
|
2283
3108
|
|
|
2284
3109
|
/**
|
|
@@ -2298,7 +3123,9 @@ interface LeadResponse {
|
|
|
2298
3123
|
* Do not edit manually.
|
|
2299
3124
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2300
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.
|
|
2301
|
-
|
|
3126
|
+
|
|
3127
|
+
**Published:** 2026-08-08
|
|
3128
|
+
* OpenAPI spec version: 2026.16.0
|
|
2302
3129
|
*/
|
|
2303
3130
|
/**
|
|
2304
3131
|
* Applicant mailing address.
|
|
@@ -2319,7 +3146,9 @@ interface MailingAddress {
|
|
|
2319
3146
|
* Do not edit manually.
|
|
2320
3147
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2321
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.
|
|
2322
|
-
|
|
3149
|
+
|
|
3150
|
+
**Published:** 2026-08-08
|
|
3151
|
+
* OpenAPI spec version: 2026.16.0
|
|
2323
3152
|
*/
|
|
2324
3153
|
/**
|
|
2325
3154
|
* Marketing tracking metadata
|
|
@@ -2338,7 +3167,9 @@ interface Tracking {
|
|
|
2338
3167
|
* Do not edit manually.
|
|
2339
3168
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2340
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.
|
|
2341
|
-
|
|
3170
|
+
|
|
3171
|
+
**Published:** 2026-08-08
|
|
3172
|
+
* OpenAPI spec version: 2026.16.0
|
|
2342
3173
|
*/
|
|
2343
3174
|
|
|
2344
3175
|
/**
|
|
@@ -2371,7 +3202,9 @@ interface LeadTransferRequest {
|
|
|
2371
3202
|
* Do not edit manually.
|
|
2372
3203
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2373
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.
|
|
2374
|
-
|
|
3205
|
+
|
|
3206
|
+
**Published:** 2026-08-08
|
|
3207
|
+
* OpenAPI spec version: 2026.16.0
|
|
2375
3208
|
*/
|
|
2376
3209
|
/**
|
|
2377
3210
|
* Evaluation outcome: 'accepted' or 'rejected'.
|
|
@@ -2387,7 +3220,9 @@ declare const LeadTransferResponseResponse: {
|
|
|
2387
3220
|
* Do not edit manually.
|
|
2388
3221
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2389
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.
|
|
2390
|
-
|
|
3223
|
+
|
|
3224
|
+
**Published:** 2026-08-08
|
|
3225
|
+
* OpenAPI spec version: 2026.16.0
|
|
2391
3226
|
*/
|
|
2392
3227
|
|
|
2393
3228
|
/**
|
|
@@ -2430,7 +3265,9 @@ interface LeadTransferResponse {
|
|
|
2430
3265
|
* Do not edit manually.
|
|
2431
3266
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2432
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.
|
|
2433
|
-
|
|
3268
|
+
|
|
3269
|
+
**Published:** 2026-08-08
|
|
3270
|
+
* OpenAPI spec version: 2026.16.0
|
|
2434
3271
|
*/
|
|
2435
3272
|
/**
|
|
2436
3273
|
* Request body for async program generation (v1)
|
|
@@ -2447,7 +3284,68 @@ interface ProgramRequest {
|
|
|
2447
3284
|
* Do not edit manually.
|
|
2448
3285
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2449
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.
|
|
2450
|
-
|
|
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
|
|
2451
3349
|
*/
|
|
2452
3350
|
/**
|
|
2453
3351
|
* Request body for creating a Program Summary Recording task (RWA-2427)
|
|
@@ -2472,7 +3370,9 @@ interface ProgramSummaryTaskRequest {
|
|
|
2472
3370
|
* Do not edit manually.
|
|
2473
3371
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2474
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.
|
|
2475
|
-
|
|
3373
|
+
|
|
3374
|
+
**Published:** 2026-08-08
|
|
3375
|
+
* OpenAPI spec version: 2026.16.0
|
|
2476
3376
|
*/
|
|
2477
3377
|
/**
|
|
2478
3378
|
* Response body for a successfully created Program Summary Recording task
|
|
@@ -2497,37 +3397,24 @@ interface ProgramSummaryTaskResponse {
|
|
|
2497
3397
|
* Do not edit manually.
|
|
2498
3398
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2499
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.
|
|
2500
|
-
* OpenAPI spec version: 2026.15.0
|
|
2501
|
-
*/
|
|
2502
|
-
/**
|
|
2503
|
-
* Error classification code
|
|
2504
|
-
*/
|
|
2505
|
-
type ReadinessErrorResponseErrorCode = typeof ReadinessErrorResponseErrorCode[keyof typeof ReadinessErrorResponseErrorCode];
|
|
2506
|
-
declare const ReadinessErrorResponseErrorCode: {
|
|
2507
|
-
readonly ER40301: "ER40301";
|
|
2508
|
-
readonly ER40305: "ER40305";
|
|
2509
|
-
};
|
|
2510
3400
|
|
|
2511
|
-
|
|
2512
|
-
*
|
|
2513
|
-
* Do not edit manually.
|
|
2514
|
-
* ARPC — Achieve Resolution Partner Connect API
|
|
2515
|
-
* 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.
|
|
2516
|
-
* OpenAPI spec version: 2026.15.0
|
|
3401
|
+
**Published:** 2026-08-08
|
|
3402
|
+
* OpenAPI spec version: 2026.16.0
|
|
2517
3403
|
*/
|
|
2518
3404
|
|
|
2519
3405
|
/**
|
|
2520
|
-
* 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.
|
|
2521
3409
|
*/
|
|
2522
3410
|
interface ReadinessErrorResponse {
|
|
2523
|
-
/** UTC timestamp of the error */
|
|
2524
|
-
timestamp?: string;
|
|
2525
|
-
/** HTTP status code */
|
|
2526
3411
|
status?: number;
|
|
2527
3412
|
/** Short error message */
|
|
2528
3413
|
error?: string;
|
|
2529
3414
|
/** Error classification code */
|
|
2530
|
-
error_code?:
|
|
3415
|
+
error_code?: string;
|
|
3416
|
+
/** UTC timestamp of the error */
|
|
3417
|
+
timestamp?: string;
|
|
2531
3418
|
/** Correlation ID for distributed tracing */
|
|
2532
3419
|
x_correlation_id?: string;
|
|
2533
3420
|
error_details?: ErrorDetails;
|
|
@@ -2538,7 +3425,9 @@ interface ReadinessErrorResponse {
|
|
|
2538
3425
|
* Do not edit manually.
|
|
2539
3426
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2540
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.
|
|
2541
|
-
|
|
3428
|
+
|
|
3429
|
+
**Published:** 2026-08-08
|
|
3430
|
+
* OpenAPI spec version: 2026.16.0
|
|
2542
3431
|
*/
|
|
2543
3432
|
|
|
2544
3433
|
/**
|
|
@@ -2564,18 +3453,18 @@ interface ReadinessResponse {
|
|
|
2564
3453
|
* Do not edit manually.
|
|
2565
3454
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2566
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.
|
|
2567
|
-
|
|
3456
|
+
|
|
3457
|
+
**Published:** 2026-08-08
|
|
3458
|
+
* OpenAPI spec version: 2026.16.0
|
|
2568
3459
|
*/
|
|
3460
|
+
|
|
2569
3461
|
/**
|
|
2570
|
-
*
|
|
3462
|
+
* Request body for registering a new applicant in the v2 DEX surface
|
|
2571
3463
|
*/
|
|
2572
|
-
interface
|
|
2573
|
-
/**
|
|
2574
|
-
|
|
2575
|
-
|
|
2576
|
-
business_flow?: string;
|
|
2577
|
-
/** Salesforce ID of the created achieve__Applicant__c record */
|
|
2578
|
-
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;
|
|
2579
3468
|
}
|
|
2580
3469
|
|
|
2581
3470
|
/**
|
|
@@ -2583,16 +3472,22 @@ interface RegisterApplicantResponse {
|
|
|
2583
3472
|
* Do not edit manually.
|
|
2584
3473
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2585
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.
|
|
2586
|
-
* OpenAPI spec version: 2026.15.0
|
|
2587
|
-
*/
|
|
2588
3475
|
|
|
3476
|
+
**Published:** 2026-08-08
|
|
3477
|
+
* OpenAPI spec version: 2026.16.0
|
|
3478
|
+
*/
|
|
2589
3479
|
/**
|
|
2590
|
-
*
|
|
3480
|
+
* Response returned after successfully registering an applicant via POST /v2/applicant/register
|
|
2591
3481
|
*/
|
|
2592
|
-
interface
|
|
2593
|
-
/**
|
|
2594
|
-
|
|
2595
|
-
|
|
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;
|
|
2596
3491
|
}
|
|
2597
3492
|
|
|
2598
3493
|
/**
|
|
@@ -2600,7 +3495,9 @@ interface RegisterApplicantV2Request {
|
|
|
2600
3495
|
* Do not edit manually.
|
|
2601
3496
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2602
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.
|
|
2603
|
-
|
|
3498
|
+
|
|
3499
|
+
**Published:** 2026-08-08
|
|
3500
|
+
* OpenAPI spec version: 2026.16.0
|
|
2604
3501
|
*/
|
|
2605
3502
|
|
|
2606
3503
|
/**
|
|
@@ -2625,7 +3522,9 @@ interface SpinwheelNetworkUserRequest {
|
|
|
2625
3522
|
* Do not edit manually.
|
|
2626
3523
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2627
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.
|
|
2628
|
-
|
|
3525
|
+
|
|
3526
|
+
**Published:** 2026-08-08
|
|
3527
|
+
* OpenAPI spec version: 2026.16.0
|
|
2629
3528
|
*/
|
|
2630
3529
|
/**
|
|
2631
3530
|
* Result of creating or connecting a Spinwheel network user
|
|
@@ -2642,7 +3541,51 @@ interface SpinwheelNetworkUserResponse {
|
|
|
2642
3541
|
* Do not edit manually.
|
|
2643
3542
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2644
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.
|
|
2645
|
-
|
|
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
|
|
2646
3589
|
*/
|
|
2647
3590
|
|
|
2648
3591
|
/**
|
|
@@ -2682,11 +3625,11 @@ interface StatelessReadinessRequest {
|
|
|
2682
3625
|
/** Total business debt amount */
|
|
2683
3626
|
business_debt?: number;
|
|
2684
3627
|
/** Primary hardship category */
|
|
2685
|
-
hardship_category?:
|
|
3628
|
+
hardship_category?: StatelessReadinessRequestHardshipCategory;
|
|
2686
3629
|
/** Free-text description when hardship category is 'other' */
|
|
2687
3630
|
hardship_category_other?: string;
|
|
2688
3631
|
/** Primary goal category */
|
|
2689
|
-
goal_category?:
|
|
3632
|
+
goal_category?: StatelessReadinessRequestGoalCategory;
|
|
2690
3633
|
/** Free-text description when goal category is 'other' */
|
|
2691
3634
|
goal_category_other?: string;
|
|
2692
3635
|
/** Justification for food expense amount */
|
|
@@ -2779,7 +3722,9 @@ interface StatelessReadinessRequest {
|
|
|
2779
3722
|
* Do not edit manually.
|
|
2780
3723
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2781
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.
|
|
2782
|
-
|
|
3725
|
+
|
|
3726
|
+
**Published:** 2026-08-08
|
|
3727
|
+
* OpenAPI spec version: 2026.16.0
|
|
2783
3728
|
*/
|
|
2784
3729
|
|
|
2785
3730
|
/**
|
|
@@ -2801,21 +3746,59 @@ interface UwSubmissionV2Response {
|
|
|
2801
3746
|
banking_disclosure_email_message?: string | null;
|
|
2802
3747
|
}
|
|
2803
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
|
+
|
|
2804
3786
|
/**
|
|
2805
3787
|
* ARPC SDK — a typed, agnostic client for FDR's ARPC DEX API (Achieve
|
|
2806
3788
|
* Resolution Partner Connect, Digital Enrollment Experience).
|
|
2807
3789
|
*
|
|
2808
|
-
* Thin by design: it owns the two-host routing
|
|
2809
|
-
*
|
|
2810
|
-
* on `sdk.api`. It does not
|
|
3790
|
+
* Thin by design: it owns the two-host routing (both derived from
|
|
3791
|
+
* `environment`), the OAuth token lifecycle, and bearer injection, and exposes
|
|
3792
|
+
* the full endpoint surface as typed operations on `sdk.api`. It does not
|
|
3793
|
+
* orchestrate the enrollment sequence — the caller
|
|
2811
3794
|
* assembles payloads and threads the `fdr_applicant_id` between calls. See
|
|
2812
3795
|
* `scripts/smoke.ts` for a full end-to-end reference sequence (incl. the program
|
|
2813
3796
|
* poll loop).
|
|
2814
3797
|
*
|
|
2815
3798
|
* Auth is lazy: the first `api` call exchanges credentials for a bearer JWT and
|
|
2816
3799
|
* caches it (~900s TTL), then re-exchanges shortly before it expires. There's no
|
|
2817
|
-
* explicit login step. Supply
|
|
2818
|
-
*
|
|
3800
|
+
* explicit login step. Supply `auth.cache` to persist the token across restarts
|
|
3801
|
+
* or share it across workers; otherwise it's held in-process.
|
|
2819
3802
|
*
|
|
2820
3803
|
* Operations never throw on a non-2xx: each returns `{ status, data, headers }`,
|
|
2821
3804
|
* so a business gate (e.g. a UW/DRA readiness failure) comes back as a normal
|
|
@@ -2828,10 +3811,11 @@ interface UwSubmissionV2Response {
|
|
|
2828
3811
|
* @example
|
|
2829
3812
|
* ```typescript
|
|
2830
3813
|
* const sdk = new ArpcSDK({
|
|
2831
|
-
*
|
|
2832
|
-
*
|
|
2833
|
-
*
|
|
2834
|
-
*
|
|
3814
|
+
* environment: "stg",
|
|
3815
|
+
* auth: {
|
|
3816
|
+
* username: "borrowbetter@seller.com",
|
|
3817
|
+
* password: process.env.ARPC_OAUTH_PASSWORD!,
|
|
3818
|
+
* },
|
|
2835
3819
|
* });
|
|
2836
3820
|
*
|
|
2837
3821
|
* // The first call authenticates automatically and caches the token.
|
|
@@ -2843,6 +3827,7 @@ declare class ArpcSDK {
|
|
|
2843
3827
|
/** The full typed endpoint surface — one method per gateway operation. */
|
|
2844
3828
|
readonly api: {
|
|
2845
3829
|
createLeadSync: (createLeadRequest: CreateLeadRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<CreateLeadResponse>>;
|
|
3830
|
+
selectProgram: (programSelectionRequest: ProgramSelectionRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<LeadResponse>>;
|
|
2846
3831
|
checkApplicationReadiness: (statelessReadinessRequest: StatelessReadinessRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<ReadinessResponse>>;
|
|
2847
3832
|
createSpinwheelNetworkUser: (spinwheelNetworkUserRequest: SpinwheelNetworkUserRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<SpinwheelNetworkUserResponse>>;
|
|
2848
3833
|
updateApplicationBankDetails: (applicantId: string, bankUpdateRequest: BankUpdateRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<LeadResponse>>;
|
|
@@ -2852,7 +3837,7 @@ declare class ArpcSDK {
|
|
|
2852
3837
|
patchLead: (fdrApplicantId: string, leadPatchRequest: LeadPatchRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<LeadResponse>>;
|
|
2853
3838
|
getApplicationReadiness: (applicantId: string, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<ReadinessResponse>>;
|
|
2854
3839
|
generateDra: (applicantId: string, draRequest: DraRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<DraResponse>>;
|
|
2855
|
-
registerApplicantV2: (registerApplicantV2Request: RegisterApplicantV2Request, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<
|
|
3840
|
+
registerApplicantV2: (registerApplicantV2Request: RegisterApplicantV2Request, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<RegisterApplicantV2Response>>;
|
|
2856
3841
|
generateProgramV1: (programRequest: ProgramRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<LeadResponse>>;
|
|
2857
3842
|
checkEligibility: (eligibilityRequest: EligibilityRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<EligibilityResponse>>;
|
|
2858
3843
|
uwSubmissionV2: (fdrApplicantId: string, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<UwSubmissionV2Response>>;
|
|
@@ -2861,4 +3846,4 @@ declare class ArpcSDK {
|
|
|
2861
3846
|
constructor(config: ArpcConfig);
|
|
2862
3847
|
}
|
|
2863
3848
|
|
|
2864
|
-
export { type ARPCErrorResponse, type Address, type Applicant, type ApplicationSendEmailResponse, type ArpcConfig, ArpcSDK, type AuditInfo, type BankDetails, type BankDetailsInput, type BankUpdateRequest, type Check, CheckType, type CoApplicant, type Consents, type CreateLeadRequest, type CreateLeadResponse, type CreditPullConsent, type DebtAccount, type DraApplicant, type DraApplicantInput, DraApplicantInputSigningType, type DraRequest, type DraResponse, type EligibilityAddress, type EligibilityApplicant, type EligibilityApplication, type EligibilityDebtAccount, type EligibilityRequest, type EligibilityResponse, type ErrorDetails, type FieldValidationError, FieldValidationErrorReasonCode, type HttpResponse, type IneligibleReason, type LeadApplicant, LeadApplicantEmploymentStatus, type LeadApplicantInput, LeadApplicantPayFrequency, type LeadApplication, LeadApplicationCreditPullSource, LeadApplicationFdrOrCss, LeadApplicationFixedIncome, LeadApplicationOwnOrRent, type LeadCondition, LeadConditionActive, type LeadCreditor, type LeadDebtAccount, LeadDebtAccountOwnership, LeadDebtAccountResponsibility, type LeadDistribution, type LeadPatchRequest, type LeadReadiness, type LeadResponse, type LeadTransferRequest, type LeadTransferResponse, LeadTransferResponseResponse, type MailingAddress, type PatchAddress, type PatchApplicant, type PatchCoApplicant, type PatchCondition, type PatchDebtAccount, type PaymentOption, type ProgramRequest, type ProgramSummaryTaskRequest, type ProgramSummaryTaskResponse, type ReadinessCheck, ReadinessCheckType, type
|
|
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 };
|