@borrowbetter/arpcsdk 0.3.0 → 0.5.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 +65 -4
- package/dist/index.d.mts +1230 -229
- package/dist/index.d.ts +1230 -229
- package/dist/index.js +31 -1
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +29 -2
- package/dist/index.mjs.map +1 -1
- package/package.json +2 -2
package/dist/index.d.mts
CHANGED
|
@@ -89,7 +89,9 @@ interface ArpcConfig {
|
|
|
89
89
|
* Do not edit manually.
|
|
90
90
|
* ARPC — Achieve Resolution Partner Connect API
|
|
91
91
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
92
|
-
|
|
92
|
+
|
|
93
|
+
**Published:** 2026-08-18
|
|
94
|
+
* OpenAPI spec version: 2026.16.1
|
|
93
95
|
*/
|
|
94
96
|
/**
|
|
95
97
|
* Stable machine-readable reason for the violation. See ValidationReasonCode.
|
|
@@ -109,7 +111,9 @@ declare const FieldValidationErrorReasonCode: {
|
|
|
109
111
|
* Do not edit manually.
|
|
110
112
|
* ARPC — Achieve Resolution Partner Connect API
|
|
111
113
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
112
|
-
|
|
114
|
+
|
|
115
|
+
**Published:** 2026-08-18
|
|
116
|
+
* OpenAPI spec version: 2026.16.1
|
|
113
117
|
*/
|
|
114
118
|
|
|
115
119
|
/**
|
|
@@ -129,7 +133,140 @@ interface FieldValidationError {
|
|
|
129
133
|
* Do not edit manually.
|
|
130
134
|
* ARPC — Achieve Resolution Partner Connect API
|
|
131
135
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
132
|
-
|
|
136
|
+
|
|
137
|
+
**Published:** 2026-08-18
|
|
138
|
+
* OpenAPI spec version: 2026.16.1
|
|
139
|
+
*/
|
|
140
|
+
/**
|
|
141
|
+
* Check type identifier
|
|
142
|
+
*/
|
|
143
|
+
type ReadinessCheckType = typeof ReadinessCheckType[keyof typeof ReadinessCheckType];
|
|
144
|
+
declare const ReadinessCheckType: {
|
|
145
|
+
readonly lead: "lead";
|
|
146
|
+
readonly uw_submission: "uw_submission";
|
|
147
|
+
readonly dra: "dra";
|
|
148
|
+
readonly readiness: "readiness";
|
|
149
|
+
};
|
|
150
|
+
|
|
151
|
+
/**
|
|
152
|
+
* Generated by orval v7.21.0 🍺
|
|
153
|
+
* Do not edit manually.
|
|
154
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
155
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
156
|
+
|
|
157
|
+
**Published:** 2026-08-18
|
|
158
|
+
* OpenAPI spec version: 2026.16.1
|
|
159
|
+
*/
|
|
160
|
+
/**
|
|
161
|
+
* Stable machine-readable code you can safely branch on.
|
|
162
|
+
*/
|
|
163
|
+
type ReadinessErrorDetailReasonCode = typeof ReadinessErrorDetailReasonCode[keyof typeof ReadinessErrorDetailReasonCode];
|
|
164
|
+
declare const ReadinessErrorDetailReasonCode: {
|
|
165
|
+
readonly REQUIRED: "REQUIRED";
|
|
166
|
+
readonly DUPLICATE_EMAIL: "DUPLICATE_EMAIL";
|
|
167
|
+
readonly HARDSHIP_CHECK_FAILED: "HARDSHIP_CHECK_FAILED";
|
|
168
|
+
readonly PO_BOX_NOT_ALLOWED: "PO_BOX_NOT_ALLOWED";
|
|
169
|
+
readonly DEBT_ACCOUNTS_MISSING: "DEBT_ACCOUNTS_MISSING";
|
|
170
|
+
readonly MEDICAL_DEBT_INVALID: "MEDICAL_DEBT_INVALID";
|
|
171
|
+
readonly MANUAL_DEBT_INVALID: "MANUAL_DEBT_INVALID";
|
|
172
|
+
readonly DEBT_TOTAL_MISMATCH: "DEBT_TOTAL_MISMATCH";
|
|
173
|
+
readonly PROGRAM_START_DATE_INVALID: "PROGRAM_START_DATE_INVALID";
|
|
174
|
+
readonly CONDITION_NOT_VERIFIED: "CONDITION_NOT_VERIFIED";
|
|
175
|
+
readonly PROVISIONAL_DEBT_ABOVE_THRESHOLD: "PROVISIONAL_DEBT_ABOVE_THRESHOLD";
|
|
176
|
+
};
|
|
177
|
+
|
|
178
|
+
/**
|
|
179
|
+
* Generated by orval v7.21.0 🍺
|
|
180
|
+
* Do not edit manually.
|
|
181
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
182
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
183
|
+
|
|
184
|
+
**Published:** 2026-08-18
|
|
185
|
+
* OpenAPI spec version: 2026.16.1
|
|
186
|
+
*/
|
|
187
|
+
|
|
188
|
+
/**
|
|
189
|
+
* Structured failure entry within a readiness check
|
|
190
|
+
* @nullable
|
|
191
|
+
*/
|
|
192
|
+
type ReadinessErrorDetail = {
|
|
193
|
+
/**
|
|
194
|
+
* Dotted JSON path of the input field that caused the failure (snake_case). Omitted when the failure is not tied to a specific field.
|
|
195
|
+
* @nullable
|
|
196
|
+
*/
|
|
197
|
+
field?: string | null;
|
|
198
|
+
/** Stable machine-readable code you can safely branch on. */
|
|
199
|
+
reason_code?: ReadinessErrorDetailReasonCode;
|
|
200
|
+
/** Human-readable explanation — same text as in errors[]. May be reworded over time; do not match on this value. */
|
|
201
|
+
message?: string;
|
|
202
|
+
} | null;
|
|
203
|
+
|
|
204
|
+
/**
|
|
205
|
+
* Generated by orval v7.21.0 🍺
|
|
206
|
+
* Do not edit manually.
|
|
207
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
208
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
209
|
+
|
|
210
|
+
**Published:** 2026-08-18
|
|
211
|
+
* OpenAPI spec version: 2026.16.1
|
|
212
|
+
*/
|
|
213
|
+
|
|
214
|
+
/**
|
|
215
|
+
* Individual readiness check result
|
|
216
|
+
*/
|
|
217
|
+
interface ReadinessCheck {
|
|
218
|
+
/** Check type identifier */
|
|
219
|
+
type?: ReadinessCheckType;
|
|
220
|
+
/** Whether this check passed */
|
|
221
|
+
verified?: boolean;
|
|
222
|
+
/**
|
|
223
|
+
* Validation error messages if the check failed
|
|
224
|
+
* @nullable
|
|
225
|
+
*/
|
|
226
|
+
errors?: (string | null)[] | null;
|
|
227
|
+
/**
|
|
228
|
+
* 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.
|
|
229
|
+
* @nullable
|
|
230
|
+
*/
|
|
231
|
+
error_details?: ReadinessErrorDetail[] | null;
|
|
232
|
+
}
|
|
233
|
+
|
|
234
|
+
/**
|
|
235
|
+
* Generated by orval v7.21.0 🍺
|
|
236
|
+
* Do not edit manually.
|
|
237
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
238
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
239
|
+
|
|
240
|
+
**Published:** 2026-08-18
|
|
241
|
+
* OpenAPI spec version: 2026.16.1
|
|
242
|
+
*/
|
|
243
|
+
|
|
244
|
+
/**
|
|
245
|
+
* Readiness check breakdown
|
|
246
|
+
* @nullable
|
|
247
|
+
*/
|
|
248
|
+
type ErrorDetails = {
|
|
249
|
+
/** Per-gate check results */
|
|
250
|
+
checks?: ReadinessCheck[];
|
|
251
|
+
/**
|
|
252
|
+
* Summary message for the readiness failure
|
|
253
|
+
* @nullable
|
|
254
|
+
*/
|
|
255
|
+
message?: string | null;
|
|
256
|
+
/** Whether a program refresh is required before re-submission */
|
|
257
|
+
is_program_refresh_required?: boolean;
|
|
258
|
+
/** Whether the application is currently UW-approved */
|
|
259
|
+
is_uw_approved?: boolean;
|
|
260
|
+
} | null;
|
|
261
|
+
|
|
262
|
+
/**
|
|
263
|
+
* Generated by orval v7.21.0 🍺
|
|
264
|
+
* Do not edit manually.
|
|
265
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
266
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
267
|
+
|
|
268
|
+
**Published:** 2026-08-18
|
|
269
|
+
* OpenAPI spec version: 2026.16.1
|
|
133
270
|
*/
|
|
134
271
|
|
|
135
272
|
/**
|
|
@@ -144,6 +281,7 @@ interface ARPCErrorResponse {
|
|
|
144
281
|
error?: string;
|
|
145
282
|
/** Field-level violations. Present only for field-validation failures (e.g. ER40001, ER00400); absent for upstream, auth, or internal errors. */
|
|
146
283
|
errors?: FieldValidationError[];
|
|
284
|
+
error_details?: ErrorDetails;
|
|
147
285
|
/** Free-text reason for non-field-validation failures (upstream rejection, auth failure, internal error). Absent when 'errors[]' is populated. */
|
|
148
286
|
message?: string;
|
|
149
287
|
/** ISO-8601 UTC timestamp of when the error occurred */
|
|
@@ -157,7 +295,9 @@ interface ARPCErrorResponse {
|
|
|
157
295
|
* Do not edit manually.
|
|
158
296
|
* ARPC — Achieve Resolution Partner Connect API
|
|
159
297
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
160
|
-
|
|
298
|
+
|
|
299
|
+
**Published:** 2026-08-18
|
|
300
|
+
* OpenAPI spec version: 2026.16.1
|
|
161
301
|
*/
|
|
162
302
|
/**
|
|
163
303
|
* Street address
|
|
@@ -180,7 +320,9 @@ interface Address {
|
|
|
180
320
|
* Do not edit manually.
|
|
181
321
|
* ARPC — Achieve Resolution Partner Connect API
|
|
182
322
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
183
|
-
|
|
323
|
+
|
|
324
|
+
**Published:** 2026-08-18
|
|
325
|
+
* OpenAPI spec version: 2026.16.1
|
|
184
326
|
*/
|
|
185
327
|
/**
|
|
186
328
|
* Address used by v2. ZIP is exposed as zip_code on the public request.
|
|
@@ -193,7 +335,7 @@ interface RegisterApplicantV2Address {
|
|
|
193
335
|
/** US state code — 2 characters */
|
|
194
336
|
state: string;
|
|
195
337
|
/** 5-digit ZIP code */
|
|
196
|
-
zip_code
|
|
338
|
+
zip_code: string;
|
|
197
339
|
/** Country code */
|
|
198
340
|
country?: string;
|
|
199
341
|
}
|
|
@@ -203,7 +345,9 @@ interface RegisterApplicantV2Address {
|
|
|
203
345
|
* Do not edit manually.
|
|
204
346
|
* ARPC — Achieve Resolution Partner Connect API
|
|
205
347
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
206
|
-
|
|
348
|
+
|
|
349
|
+
**Published:** 2026-08-18
|
|
350
|
+
* OpenAPI spec version: 2026.16.1
|
|
207
351
|
*/
|
|
208
352
|
|
|
209
353
|
/**
|
|
@@ -221,7 +365,7 @@ interface Applicant {
|
|
|
221
365
|
/** Secondary / evening phone number (required, 10 digits) */
|
|
222
366
|
evening_phone_number: string;
|
|
223
367
|
/**
|
|
224
|
-
* Social Security Number — exactly 9 numeric digits, no dashes.
|
|
368
|
+
* Social Security Number — exactly 9 numeric digits, no dashes. Required when Spinwheel is used as the credit bureau; optional for any other bureau.
|
|
225
369
|
* @pattern ^\d{9}$
|
|
226
370
|
*/
|
|
227
371
|
ssn: string;
|
|
@@ -229,7 +373,7 @@ interface Applicant {
|
|
|
229
373
|
fdr_applicant_id?: string;
|
|
230
374
|
/** Seller-assigned applicant reference ID */
|
|
231
375
|
reference_id?: string;
|
|
232
|
-
/** Date the applicant gave user consent (
|
|
376
|
+
/** Date the applicant gave user consent (YYYY-MM-DD) */
|
|
233
377
|
consent_date: string;
|
|
234
378
|
/** Applicant date of birth (YYYY-MM-DD, required) */
|
|
235
379
|
date_of_birth: string;
|
|
@@ -244,7 +388,9 @@ interface Applicant {
|
|
|
244
388
|
* Do not edit manually.
|
|
245
389
|
* ARPC — Achieve Resolution Partner Connect API
|
|
246
390
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
247
|
-
|
|
391
|
+
|
|
392
|
+
**Published:** 2026-08-18
|
|
393
|
+
* OpenAPI spec version: 2026.16.1
|
|
248
394
|
*/
|
|
249
395
|
interface ApplicationSendEmailResponse {
|
|
250
396
|
status?: string;
|
|
@@ -258,7 +404,9 @@ interface ApplicationSendEmailResponse {
|
|
|
258
404
|
* Do not edit manually.
|
|
259
405
|
* ARPC — Achieve Resolution Partner Connect API
|
|
260
406
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
261
|
-
|
|
407
|
+
|
|
408
|
+
**Published:** 2026-08-18
|
|
409
|
+
* OpenAPI spec version: 2026.16.1
|
|
262
410
|
*/
|
|
263
411
|
/**
|
|
264
412
|
* Audit metadata
|
|
@@ -273,7 +421,45 @@ interface AuditInfo {
|
|
|
273
421
|
* Do not edit manually.
|
|
274
422
|
* ARPC — Achieve Resolution Partner Connect API
|
|
275
423
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
276
|
-
|
|
424
|
+
|
|
425
|
+
**Published:** 2026-08-18
|
|
426
|
+
* OpenAPI spec version: 2026.16.1
|
|
427
|
+
*/
|
|
428
|
+
/**
|
|
429
|
+
* Account type
|
|
430
|
+
*/
|
|
431
|
+
type BankDetailsAccountType = typeof BankDetailsAccountType[keyof typeof BankDetailsAccountType];
|
|
432
|
+
declare const BankDetailsAccountType: {
|
|
433
|
+
readonly Checking: "Checking";
|
|
434
|
+
readonly Savings: "Savings";
|
|
435
|
+
};
|
|
436
|
+
|
|
437
|
+
/**
|
|
438
|
+
* Generated by orval v7.21.0 🍺
|
|
439
|
+
* Do not edit manually.
|
|
440
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
441
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
442
|
+
|
|
443
|
+
**Published:** 2026-08-18
|
|
444
|
+
* OpenAPI spec version: 2026.16.1
|
|
445
|
+
*/
|
|
446
|
+
/**
|
|
447
|
+
* Account sub-type
|
|
448
|
+
*/
|
|
449
|
+
type BankDetailsAccountSubtype = typeof BankDetailsAccountSubtype[keyof typeof BankDetailsAccountSubtype];
|
|
450
|
+
declare const BankDetailsAccountSubtype: {
|
|
451
|
+
readonly Business: "Business";
|
|
452
|
+
readonly Personal: "Personal";
|
|
453
|
+
};
|
|
454
|
+
|
|
455
|
+
/**
|
|
456
|
+
* Generated by orval v7.21.0 🍺
|
|
457
|
+
* Do not edit manually.
|
|
458
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
459
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
460
|
+
|
|
461
|
+
**Published:** 2026-08-18
|
|
462
|
+
* OpenAPI spec version: 2026.16.1
|
|
277
463
|
*/
|
|
278
464
|
|
|
279
465
|
/**
|
|
@@ -284,9 +470,9 @@ type BankDetails = {
|
|
|
284
470
|
/** Bank name */
|
|
285
471
|
name?: string;
|
|
286
472
|
/** Account type */
|
|
287
|
-
account_type?:
|
|
473
|
+
account_type?: BankDetailsAccountType;
|
|
288
474
|
/** Account sub-type */
|
|
289
|
-
account_subtype?:
|
|
475
|
+
account_subtype?: BankDetailsAccountSubtype;
|
|
290
476
|
/** Bank account number */
|
|
291
477
|
account_number?: string;
|
|
292
478
|
/** Bank routing number */
|
|
@@ -313,7 +499,9 @@ type BankDetails = {
|
|
|
313
499
|
* Do not edit manually.
|
|
314
500
|
* ARPC — Achieve Resolution Partner Connect API
|
|
315
501
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
316
|
-
|
|
502
|
+
|
|
503
|
+
**Published:** 2026-08-18
|
|
504
|
+
* OpenAPI spec version: 2026.16.1
|
|
317
505
|
*/
|
|
318
506
|
/**
|
|
319
507
|
* Bank account input fields
|
|
@@ -330,7 +518,9 @@ interface BankDetailsInput {
|
|
|
330
518
|
* Do not edit manually.
|
|
331
519
|
* ARPC — Achieve Resolution Partner Connect API
|
|
332
520
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
333
|
-
|
|
521
|
+
|
|
522
|
+
**Published:** 2026-08-18
|
|
523
|
+
* OpenAPI spec version: 2026.16.1
|
|
334
524
|
*/
|
|
335
525
|
|
|
336
526
|
/**
|
|
@@ -349,7 +539,9 @@ interface BankUpdateRequest {
|
|
|
349
539
|
* Do not edit manually.
|
|
350
540
|
* ARPC — Achieve Resolution Partner Connect API
|
|
351
541
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
352
|
-
|
|
542
|
+
|
|
543
|
+
**Published:** 2026-08-18
|
|
544
|
+
* OpenAPI spec version: 2026.16.1
|
|
353
545
|
*/
|
|
354
546
|
/**
|
|
355
547
|
* Check type identifier
|
|
@@ -365,7 +557,9 @@ declare const CheckType: {
|
|
|
365
557
|
* Do not edit manually.
|
|
366
558
|
* ARPC — Achieve Resolution Partner Connect API
|
|
367
559
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
368
|
-
|
|
560
|
+
|
|
561
|
+
**Published:** 2026-08-18
|
|
562
|
+
* OpenAPI spec version: 2026.16.1
|
|
369
563
|
*/
|
|
370
564
|
|
|
371
565
|
/**
|
|
@@ -381,6 +575,11 @@ interface Check {
|
|
|
381
575
|
* @nullable
|
|
382
576
|
*/
|
|
383
577
|
errors?: (string | null)[] | null;
|
|
578
|
+
/**
|
|
579
|
+
* Structured validation details for this readiness check
|
|
580
|
+
* @nullable
|
|
581
|
+
*/
|
|
582
|
+
error_details?: ReadinessErrorDetail[] | null;
|
|
384
583
|
}
|
|
385
584
|
|
|
386
585
|
/**
|
|
@@ -388,7 +587,9 @@ interface Check {
|
|
|
388
587
|
* Do not edit manually.
|
|
389
588
|
* ARPC — Achieve Resolution Partner Connect API
|
|
390
589
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
391
|
-
|
|
590
|
+
|
|
591
|
+
**Published:** 2026-08-18
|
|
592
|
+
* OpenAPI spec version: 2026.16.1
|
|
392
593
|
*/
|
|
393
594
|
|
|
394
595
|
/**
|
|
@@ -456,7 +657,9 @@ interface CoApplicant {
|
|
|
456
657
|
* Do not edit manually.
|
|
457
658
|
* ARPC — Achieve Resolution Partner Connect API
|
|
458
659
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
459
|
-
|
|
660
|
+
|
|
661
|
+
**Published:** 2026-08-18
|
|
662
|
+
* OpenAPI spec version: 2026.16.1
|
|
460
663
|
*/
|
|
461
664
|
/**
|
|
462
665
|
* Required consent strings for regulatory and platform compliance
|
|
@@ -479,7 +682,9 @@ interface Consents {
|
|
|
479
682
|
* Do not edit manually.
|
|
480
683
|
* ARPC — Achieve Resolution Partner Connect API
|
|
481
684
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
482
|
-
|
|
685
|
+
|
|
686
|
+
**Published:** 2026-08-18
|
|
687
|
+
* OpenAPI spec version: 2026.16.1
|
|
483
688
|
*/
|
|
484
689
|
/**
|
|
485
690
|
* Lead distribution routing configuration
|
|
@@ -496,7 +701,51 @@ interface LeadDistribution {
|
|
|
496
701
|
* Do not edit manually.
|
|
497
702
|
* ARPC — Achieve Resolution Partner Connect API
|
|
498
703
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
499
|
-
|
|
704
|
+
|
|
705
|
+
**Published:** 2026-08-18
|
|
706
|
+
* OpenAPI spec version: 2026.16.1
|
|
707
|
+
*/
|
|
708
|
+
/**
|
|
709
|
+
* Primary hardship category
|
|
710
|
+
*/
|
|
711
|
+
type CreateLeadRequestHardshipCategory = typeof CreateLeadRequestHardshipCategory[keyof typeof CreateLeadRequestHardshipCategory];
|
|
712
|
+
declare const CreateLeadRequestHardshipCategory: {
|
|
713
|
+
readonly Job_Loss: "Job Loss";
|
|
714
|
+
readonly Reduced_Income: "Reduced Income";
|
|
715
|
+
readonly Medical: "Medical";
|
|
716
|
+
readonly Divorce: "Divorce";
|
|
717
|
+
readonly Unexpected_Expenses: "Unexpected Expenses";
|
|
718
|
+
readonly Other: "Other";
|
|
719
|
+
};
|
|
720
|
+
|
|
721
|
+
/**
|
|
722
|
+
* Generated by orval v7.21.0 🍺
|
|
723
|
+
* Do not edit manually.
|
|
724
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
725
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
726
|
+
|
|
727
|
+
**Published:** 2026-08-18
|
|
728
|
+
* OpenAPI spec version: 2026.16.1
|
|
729
|
+
*/
|
|
730
|
+
/**
|
|
731
|
+
* Primary goal category
|
|
732
|
+
*/
|
|
733
|
+
type CreateLeadRequestGoalCategory = typeof CreateLeadRequestGoalCategory[keyof typeof CreateLeadRequestGoalCategory];
|
|
734
|
+
declare const CreateLeadRequestGoalCategory: {
|
|
735
|
+
readonly Avoid_Bankruptcy: "Avoid Bankruptcy";
|
|
736
|
+
readonly Get_out_of_Debt: "Get out of Debt";
|
|
737
|
+
readonly 'Build_personal_wealth,_savings': "Build personal wealth, savings";
|
|
738
|
+
readonly Relieve_pressure_of_monthly_bills: "Relieve pressure of monthly bills";
|
|
739
|
+
};
|
|
740
|
+
|
|
741
|
+
/**
|
|
742
|
+
* Generated by orval v7.21.0 🍺
|
|
743
|
+
* Do not edit manually.
|
|
744
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
745
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
746
|
+
|
|
747
|
+
**Published:** 2026-08-18
|
|
748
|
+
* OpenAPI spec version: 2026.16.1
|
|
500
749
|
*/
|
|
501
750
|
|
|
502
751
|
/**
|
|
@@ -574,7 +823,9 @@ interface LeadApplicantInput {
|
|
|
574
823
|
* Do not edit manually.
|
|
575
824
|
* ARPC — Achieve Resolution Partner Connect API
|
|
576
825
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
577
|
-
|
|
826
|
+
|
|
827
|
+
**Published:** 2026-08-18
|
|
828
|
+
* OpenAPI spec version: 2026.16.1
|
|
578
829
|
*/
|
|
579
830
|
/**
|
|
580
831
|
* Whether the condition is currently active
|
|
@@ -590,7 +841,29 @@ declare const LeadConditionActive: {
|
|
|
590
841
|
* Do not edit manually.
|
|
591
842
|
* ARPC — Achieve Resolution Partner Connect API
|
|
592
843
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
593
|
-
|
|
844
|
+
|
|
845
|
+
**Published:** 2026-08-18
|
|
846
|
+
* OpenAPI spec version: 2026.16.1
|
|
847
|
+
*/
|
|
848
|
+
/**
|
|
849
|
+
* Condition type. soft-condition types omit the verified field in the response.
|
|
850
|
+
*/
|
|
851
|
+
type LeadConditionType = typeof LeadConditionType[keyof typeof LeadConditionType];
|
|
852
|
+
declare const LeadConditionType: {
|
|
853
|
+
readonly 'soft-condition': "soft-condition";
|
|
854
|
+
readonly 'hard-condition': "hard-condition";
|
|
855
|
+
readonly waiver: "waiver";
|
|
856
|
+
readonly acknowledgement: "acknowledgement";
|
|
857
|
+
};
|
|
858
|
+
|
|
859
|
+
/**
|
|
860
|
+
* Generated by orval v7.21.0 🍺
|
|
861
|
+
* Do not edit manually.
|
|
862
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
863
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
864
|
+
|
|
865
|
+
**Published:** 2026-08-18
|
|
866
|
+
* OpenAPI spec version: 2026.16.1
|
|
594
867
|
*/
|
|
595
868
|
|
|
596
869
|
/**
|
|
@@ -605,7 +878,7 @@ type LeadCondition = {
|
|
|
605
878
|
/** Whether the condition is currently active */
|
|
606
879
|
active?: LeadConditionActive;
|
|
607
880
|
/** Condition type. soft-condition types omit the verified field in the response. */
|
|
608
|
-
type?:
|
|
881
|
+
type?: LeadConditionType;
|
|
609
882
|
/**
|
|
610
883
|
* Whether the condition has been verified by underwriting. Absent for soft-condition type.
|
|
611
884
|
* @nullable
|
|
@@ -627,7 +900,9 @@ type LeadCondition = {
|
|
|
627
900
|
* Do not edit manually.
|
|
628
901
|
* ARPC — Achieve Resolution Partner Connect API
|
|
629
902
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
630
|
-
|
|
903
|
+
|
|
904
|
+
**Published:** 2026-08-18
|
|
905
|
+
* OpenAPI spec version: 2026.16.1
|
|
631
906
|
*/
|
|
632
907
|
|
|
633
908
|
/**
|
|
@@ -705,7 +980,9 @@ interface DebtAccount {
|
|
|
705
980
|
* Do not edit manually.
|
|
706
981
|
* ARPC — Achieve Resolution Partner Connect API
|
|
707
982
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
708
|
-
|
|
983
|
+
|
|
984
|
+
**Published:** 2026-08-18
|
|
985
|
+
* OpenAPI spec version: 2026.16.1
|
|
709
986
|
*/
|
|
710
987
|
|
|
711
988
|
/**
|
|
@@ -807,12 +1084,12 @@ interface CreateLeadRequest {
|
|
|
807
1084
|
transportation_expenses?: number;
|
|
808
1085
|
/** Other miscellaneous monthly expenses (USD) */
|
|
809
1086
|
other_expenses_describe?: number;
|
|
810
|
-
/** Primary hardship category
|
|
811
|
-
hardship_category?:
|
|
1087
|
+
/** Primary hardship category */
|
|
1088
|
+
hardship_category?: CreateLeadRequestHardshipCategory;
|
|
812
1089
|
/** Free-text description when hardship category is 'other' */
|
|
813
1090
|
hardship_category_other?: string;
|
|
814
|
-
/** Primary goal category
|
|
815
|
-
goal_category?:
|
|
1091
|
+
/** Primary goal category */
|
|
1092
|
+
goal_category?: CreateLeadRequestGoalCategory;
|
|
816
1093
|
/** Free-text description when goal category is 'other' */
|
|
817
1094
|
goal_category_other?: string;
|
|
818
1095
|
/** Next paycheck date (YYYY-MM-DD) */
|
|
@@ -851,17 +1128,88 @@ interface CreateLeadRequest {
|
|
|
851
1128
|
* Do not edit manually.
|
|
852
1129
|
* ARPC — Achieve Resolution Partner Connect API
|
|
853
1130
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
854
|
-
|
|
1131
|
+
|
|
1132
|
+
**Published:** 2026-08-18
|
|
1133
|
+
* OpenAPI spec version: 2026.16.1
|
|
1134
|
+
*/
|
|
1135
|
+
/**
|
|
1136
|
+
* Current program / opportunity stage
|
|
1137
|
+
*/
|
|
1138
|
+
type LeadApplicationStatus = typeof LeadApplicationStatus[keyof typeof LeadApplicationStatus];
|
|
1139
|
+
declare const LeadApplicationStatus: {
|
|
1140
|
+
readonly Attempting_Contact: "Attempting Contact";
|
|
1141
|
+
readonly Contacted: "Contacted";
|
|
1142
|
+
readonly Waiting_for_Statements: "Waiting for Statements";
|
|
1143
|
+
readonly Submit_to_UW: "Submit to UW";
|
|
1144
|
+
readonly UW_Processing: "UW Processing";
|
|
1145
|
+
readonly Waiting_for_Agreement: "Waiting for Agreement";
|
|
1146
|
+
readonly Agreement_Review: "Agreement Review";
|
|
1147
|
+
readonly Welcome_Call_Pending: "Welcome Call Pending";
|
|
1148
|
+
readonly Attorney_Review: "Attorney Review";
|
|
1149
|
+
readonly Pending_Enrollment: "Pending Enrollment";
|
|
1150
|
+
readonly Enrolled_Client: "Enrolled Client";
|
|
1151
|
+
};
|
|
1152
|
+
|
|
1153
|
+
/**
|
|
1154
|
+
* Generated by orval v7.21.0 🍺
|
|
1155
|
+
* Do not edit manually.
|
|
1156
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1157
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1158
|
+
|
|
1159
|
+
**Published:** 2026-08-18
|
|
1160
|
+
* OpenAPI spec version: 2026.16.1
|
|
1161
|
+
*/
|
|
1162
|
+
/**
|
|
1163
|
+
* Client's preferred language
|
|
1164
|
+
*/
|
|
1165
|
+
type LeadApplicationLanguage = typeof LeadApplicationLanguage[keyof typeof LeadApplicationLanguage];
|
|
1166
|
+
declare const LeadApplicationLanguage: {
|
|
1167
|
+
readonly English: "English";
|
|
1168
|
+
readonly Spanish: "Spanish";
|
|
1169
|
+
};
|
|
1170
|
+
|
|
1171
|
+
/**
|
|
1172
|
+
* Generated by orval v7.21.0 🍺
|
|
1173
|
+
* Do not edit manually.
|
|
1174
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1175
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1176
|
+
|
|
1177
|
+
**Published:** 2026-08-18
|
|
1178
|
+
* OpenAPI spec version: 2026.16.1
|
|
1179
|
+
*/
|
|
1180
|
+
/**
|
|
1181
|
+
* Bankruptcy status on file
|
|
1182
|
+
*/
|
|
1183
|
+
type LeadApplicantBankruptcy = typeof LeadApplicantBankruptcy[keyof typeof LeadApplicantBankruptcy];
|
|
1184
|
+
declare const LeadApplicantBankruptcy: {
|
|
1185
|
+
readonly No: "No";
|
|
1186
|
+
readonly Chapter_7: "Chapter 7";
|
|
1187
|
+
readonly Chapter_11: "Chapter 11";
|
|
1188
|
+
readonly Chapter_12: "Chapter 12";
|
|
1189
|
+
readonly Chapter_13: "Chapter 13";
|
|
1190
|
+
};
|
|
1191
|
+
|
|
1192
|
+
/**
|
|
1193
|
+
* Generated by orval v7.21.0 🍺
|
|
1194
|
+
* Do not edit manually.
|
|
1195
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1196
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1197
|
+
|
|
1198
|
+
**Published:** 2026-08-18
|
|
1199
|
+
* OpenAPI spec version: 2026.16.1
|
|
855
1200
|
*/
|
|
856
1201
|
/**
|
|
857
1202
|
* Pay frequency
|
|
858
1203
|
*/
|
|
859
1204
|
type LeadApplicantPayFrequency = typeof LeadApplicantPayFrequency[keyof typeof LeadApplicantPayFrequency];
|
|
860
1205
|
declare const LeadApplicantPayFrequency: {
|
|
1206
|
+
readonly none: "none";
|
|
861
1207
|
readonly weekly: "weekly";
|
|
862
1208
|
readonly 'bi-weekly': "bi-weekly";
|
|
863
|
-
readonly
|
|
864
|
-
readonly
|
|
1209
|
+
readonly split: "split";
|
|
1210
|
+
readonly regular: "regular";
|
|
1211
|
+
readonly irregular: "irregular";
|
|
1212
|
+
readonly unknown: "unknown";
|
|
865
1213
|
};
|
|
866
1214
|
|
|
867
1215
|
/**
|
|
@@ -869,7 +1217,9 @@ declare const LeadApplicantPayFrequency: {
|
|
|
869
1217
|
* Do not edit manually.
|
|
870
1218
|
* ARPC — Achieve Resolution Partner Connect API
|
|
871
1219
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
872
|
-
|
|
1220
|
+
|
|
1221
|
+
**Published:** 2026-08-18
|
|
1222
|
+
* OpenAPI spec version: 2026.16.1
|
|
873
1223
|
*/
|
|
874
1224
|
/**
|
|
875
1225
|
* Current employment status
|
|
@@ -879,7 +1229,7 @@ declare const LeadApplicantEmploymentStatus: {
|
|
|
879
1229
|
readonly 'Full-Time': "Full-Time";
|
|
880
1230
|
readonly 'Part-Time': "Part-Time";
|
|
881
1231
|
readonly 'Self-Employed': "Self-Employed";
|
|
882
|
-
readonly
|
|
1232
|
+
readonly Not_Employed: "Not Employed";
|
|
883
1233
|
readonly Retired: "Retired";
|
|
884
1234
|
readonly Other: "Other";
|
|
885
1235
|
};
|
|
@@ -889,7 +1239,9 @@ declare const LeadApplicantEmploymentStatus: {
|
|
|
889
1239
|
* Do not edit manually.
|
|
890
1240
|
* ARPC — Achieve Resolution Partner Connect API
|
|
891
1241
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
892
|
-
|
|
1242
|
+
|
|
1243
|
+
**Published:** 2026-08-18
|
|
1244
|
+
* OpenAPI spec version: 2026.16.1
|
|
893
1245
|
*/
|
|
894
1246
|
|
|
895
1247
|
/**
|
|
@@ -912,7 +1264,7 @@ type LeadApplicant = {
|
|
|
912
1264
|
/** Monthly unemployment income (USD) */
|
|
913
1265
|
unemployment?: number;
|
|
914
1266
|
/** Bankruptcy status on file */
|
|
915
|
-
bankruptcy?:
|
|
1267
|
+
bankruptcy?: LeadApplicantBankruptcy;
|
|
916
1268
|
/**
|
|
917
1269
|
* Conditions associated with this applicant
|
|
918
1270
|
* @nullable
|
|
@@ -988,7 +1340,79 @@ type LeadApplicant = {
|
|
|
988
1340
|
* Do not edit manually.
|
|
989
1341
|
* ARPC — Achieve Resolution Partner Connect API
|
|
990
1342
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
991
|
-
|
|
1343
|
+
|
|
1344
|
+
**Published:** 2026-08-18
|
|
1345
|
+
* OpenAPI spec version: 2026.16.1
|
|
1346
|
+
*/
|
|
1347
|
+
/**
|
|
1348
|
+
* Sub-status of the current stage
|
|
1349
|
+
*/
|
|
1350
|
+
type LeadApplicationSubStatus = typeof LeadApplicationSubStatus[keyof typeof LeadApplicationSubStatus];
|
|
1351
|
+
declare const LeadApplicationSubStatus: {
|
|
1352
|
+
readonly UW_Approved: "UW Approved";
|
|
1353
|
+
readonly UW_Conditional_Approval: "UW Conditional Approval";
|
|
1354
|
+
readonly Agreement_Not_Generated: "Agreement Not Generated";
|
|
1355
|
+
readonly View_Only_Agreement_Sent: "View Only Agreement Sent";
|
|
1356
|
+
readonly Agreement_Acknowledgement_Sent: "Agreement Acknowledgement Sent";
|
|
1357
|
+
readonly Agreement_Acknowledgement_Received: "Agreement Acknowledgement Received";
|
|
1358
|
+
readonly Agreement_Acknowledgement_Pending: "Agreement Acknowledgement Pending";
|
|
1359
|
+
readonly Agreement_Generated: "Agreement Generated";
|
|
1360
|
+
readonly 'Agreement_Sent_-_Signature_Pending': "Agreement Sent - Signature Pending";
|
|
1361
|
+
readonly Agreement_Not_Sent: "Agreement Not Sent";
|
|
1362
|
+
readonly Agreement_Voided: "Agreement Voided";
|
|
1363
|
+
readonly Client_Declined_Agreement: "Client Declined Agreement";
|
|
1364
|
+
readonly Agreement_Update_Required: "Agreement Update Required";
|
|
1365
|
+
readonly Agreement_Received: "Agreement Received";
|
|
1366
|
+
readonly Welcome_Call_Ready: "Welcome Call Ready";
|
|
1367
|
+
readonly Welcome_Call_Complete: "Welcome Call Complete";
|
|
1368
|
+
readonly Not_Interested: "Not Interested";
|
|
1369
|
+
readonly Low_Debt: "Low Debt";
|
|
1370
|
+
readonly Bad_State: "Bad State";
|
|
1371
|
+
readonly Pushed_to_CS_SalesForce: "Pushed to CS SalesForce";
|
|
1372
|
+
readonly Request_Additional_Info: "Request Additional Info";
|
|
1373
|
+
readonly Resubmit_to_UW: "Resubmit to UW";
|
|
1374
|
+
readonly Assign_to_UW: "Assign to UW";
|
|
1375
|
+
readonly Assigned_to_UW: "Assigned to UW";
|
|
1376
|
+
readonly Leader_Review: "Leader Review";
|
|
1377
|
+
readonly Resubmit_to_Welcome_Call: "Resubmit to Welcome Call";
|
|
1378
|
+
readonly Pending_Documents: "Pending Documents";
|
|
1379
|
+
readonly Resubmit_to_Agreement_Review: "Resubmit to Agreement Review";
|
|
1380
|
+
readonly Aborted: "Aborted";
|
|
1381
|
+
readonly Client_Termination: "Client Termination";
|
|
1382
|
+
readonly Pending_Enrollment: "Pending Enrollment";
|
|
1383
|
+
readonly UW_Review_Required: "UW Review Required";
|
|
1384
|
+
readonly DNC: "DNC";
|
|
1385
|
+
readonly Resubmit_for_Enrollment: "Resubmit for Enrollment";
|
|
1386
|
+
readonly Unable_to_contact: "Unable to contact";
|
|
1387
|
+
readonly Partner_Transfer: "Partner Transfer";
|
|
1388
|
+
readonly Internal_Transfer: "Internal Transfer";
|
|
1389
|
+
readonly Program_Review_Complete: "Program Review Complete";
|
|
1390
|
+
readonly Sending_for_Attorney_Review: "Sending for Attorney Review";
|
|
1391
|
+
readonly Unable_to_Send_for_Attorney_Review: "Unable to Send for Attorney Review";
|
|
1392
|
+
readonly Attorney_Routing_Failed: "Attorney Routing Failed";
|
|
1393
|
+
readonly Sent_for_Attorney_Review: "Sent for Attorney Review";
|
|
1394
|
+
readonly Received_by_Law_Firm: "Received by Law Firm";
|
|
1395
|
+
readonly Attorney_Unable_to_Contact: "Attorney Unable to Contact";
|
|
1396
|
+
readonly Resubmit_to_Attorney_Review: "Resubmit to Attorney Review";
|
|
1397
|
+
readonly Attorney_Review_Update: "Attorney Review Update";
|
|
1398
|
+
readonly Attorney_Agreement_Signed: "Attorney Agreement Signed";
|
|
1399
|
+
readonly Attorney_Rejection: "Attorney Rejection";
|
|
1400
|
+
readonly Attorney_Law_Firm_Enrolled: "Attorney Law Firm Enrolled";
|
|
1401
|
+
readonly Program_Review_Ready: "Program Review Ready";
|
|
1402
|
+
readonly Agreement_Paused: "Agreement Paused";
|
|
1403
|
+
readonly 'Attorney_Call-Back_Scheduled': "Attorney Call-Back Scheduled";
|
|
1404
|
+
readonly Request_for_Change: "Request for Change";
|
|
1405
|
+
readonly Appointment_Missed: "Appointment Missed";
|
|
1406
|
+
};
|
|
1407
|
+
|
|
1408
|
+
/**
|
|
1409
|
+
* Generated by orval v7.21.0 🍺
|
|
1410
|
+
* Do not edit manually.
|
|
1411
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1412
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1413
|
+
|
|
1414
|
+
**Published:** 2026-08-18
|
|
1415
|
+
* OpenAPI spec version: 2026.16.1
|
|
992
1416
|
*/
|
|
993
1417
|
/**
|
|
994
1418
|
* Indicates whether the program is FDR or CSS serviced
|
|
@@ -1004,7 +1428,28 @@ declare const LeadApplicationFdrOrCss: {
|
|
|
1004
1428
|
* Do not edit manually.
|
|
1005
1429
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1006
1430
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1007
|
-
|
|
1431
|
+
|
|
1432
|
+
**Published:** 2026-08-18
|
|
1433
|
+
* OpenAPI spec version: 2026.16.1
|
|
1434
|
+
*/
|
|
1435
|
+
/**
|
|
1436
|
+
* Draft frequency type
|
|
1437
|
+
*/
|
|
1438
|
+
type LeadApplicationDraftType = typeof LeadApplicationDraftType[keyof typeof LeadApplicationDraftType];
|
|
1439
|
+
declare const LeadApplicationDraftType: {
|
|
1440
|
+
readonly 'Bi-Weekly': "Bi-Weekly";
|
|
1441
|
+
readonly Regular: "Regular";
|
|
1442
|
+
readonly Split: "Split";
|
|
1443
|
+
};
|
|
1444
|
+
|
|
1445
|
+
/**
|
|
1446
|
+
* Generated by orval v7.21.0 🍺
|
|
1447
|
+
* Do not edit manually.
|
|
1448
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1449
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1450
|
+
|
|
1451
|
+
**Published:** 2026-08-18
|
|
1452
|
+
* OpenAPI spec version: 2026.16.1
|
|
1008
1453
|
*/
|
|
1009
1454
|
/**
|
|
1010
1455
|
* Whether client is on fixed income. Salesforce returns this as the string \"Yes\" or \"No\" (not a boolean).
|
|
@@ -1020,7 +1465,9 @@ declare const LeadApplicationFixedIncome: {
|
|
|
1020
1465
|
* Do not edit manually.
|
|
1021
1466
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1022
1467
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1023
|
-
|
|
1468
|
+
|
|
1469
|
+
**Published:** 2026-08-18
|
|
1470
|
+
* OpenAPI spec version: 2026.16.1
|
|
1024
1471
|
*/
|
|
1025
1472
|
/**
|
|
1026
1473
|
* Whether the client owns or rents their home
|
|
@@ -1036,15 +1483,21 @@ declare const LeadApplicationOwnOrRent: {
|
|
|
1036
1483
|
* Do not edit manually.
|
|
1037
1484
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1038
1485
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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
|
-
|
|
1486
|
+
|
|
1487
|
+
**Published:** 2026-08-18
|
|
1488
|
+
* OpenAPI spec version: 2026.16.1
|
|
1040
1489
|
*/
|
|
1041
1490
|
/**
|
|
1042
|
-
*
|
|
1491
|
+
* Primary hardship category
|
|
1043
1492
|
*/
|
|
1044
|
-
type
|
|
1045
|
-
declare const
|
|
1046
|
-
readonly
|
|
1047
|
-
readonly
|
|
1493
|
+
type LeadApplicationHardshipCategory = typeof LeadApplicationHardshipCategory[keyof typeof LeadApplicationHardshipCategory];
|
|
1494
|
+
declare const LeadApplicationHardshipCategory: {
|
|
1495
|
+
readonly Job_Loss: "Job Loss";
|
|
1496
|
+
readonly Reduced_Income: "Reduced Income";
|
|
1497
|
+
readonly Medical: "Medical";
|
|
1498
|
+
readonly Divorce: "Divorce";
|
|
1499
|
+
readonly Unexpected_Expenses: "Unexpected Expenses";
|
|
1500
|
+
readonly Other: "Other";
|
|
1048
1501
|
};
|
|
1049
1502
|
|
|
1050
1503
|
/**
|
|
@@ -1052,20 +1505,84 @@ declare const LeadApplicationCreditPullSource: {
|
|
|
1052
1505
|
* Do not edit manually.
|
|
1053
1506
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1054
1507
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1055
|
-
|
|
1508
|
+
|
|
1509
|
+
**Published:** 2026-08-18
|
|
1510
|
+
* OpenAPI spec version: 2026.16.1
|
|
1056
1511
|
*/
|
|
1057
1512
|
/**
|
|
1058
|
-
*
|
|
1513
|
+
* Client's primary financial goal category
|
|
1059
1514
|
*/
|
|
1060
|
-
|
|
1061
|
-
|
|
1062
|
-
|
|
1063
|
-
|
|
1064
|
-
|
|
1065
|
-
|
|
1066
|
-
|
|
1067
|
-
|
|
1068
|
-
|
|
1515
|
+
type LeadApplicationGoalCategory = typeof LeadApplicationGoalCategory[keyof typeof LeadApplicationGoalCategory];
|
|
1516
|
+
declare const LeadApplicationGoalCategory: {
|
|
1517
|
+
readonly Avoid_Bankruptcy: "Avoid Bankruptcy";
|
|
1518
|
+
readonly Get_out_of_Debt: "Get out of Debt";
|
|
1519
|
+
readonly 'Build_personal_wealth,_savings': "Build personal wealth, savings";
|
|
1520
|
+
readonly Relieve_pressure_of_monthly_bills: "Relieve pressure of monthly bills";
|
|
1521
|
+
};
|
|
1522
|
+
|
|
1523
|
+
/**
|
|
1524
|
+
* Generated by orval v7.21.0 🍺
|
|
1525
|
+
* Do not edit manually.
|
|
1526
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1527
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1528
|
+
|
|
1529
|
+
**Published:** 2026-08-18
|
|
1530
|
+
* OpenAPI spec version: 2026.16.1
|
|
1531
|
+
*/
|
|
1532
|
+
/**
|
|
1533
|
+
* Client's secondary financial goal
|
|
1534
|
+
*/
|
|
1535
|
+
type LeadApplicationSecondaryGoal = typeof LeadApplicationSecondaryGoal[keyof typeof LeadApplicationSecondaryGoal];
|
|
1536
|
+
declare const LeadApplicationSecondaryGoal: {
|
|
1537
|
+
readonly Purchase_a_home: "Purchase a home";
|
|
1538
|
+
readonly 'Major_purchase_(eg_car,_vacation,_home_improvement,_etc)': "Major purchase (e.g. car, vacation, home improvement, etc)";
|
|
1539
|
+
readonly Improve_Credit_Score: "Improve Credit Score";
|
|
1540
|
+
readonly Retirement: "Retirement";
|
|
1541
|
+
readonly Get_married: "Get married";
|
|
1542
|
+
readonly 'Pay_for_children\'s_college': "Pay for children's college";
|
|
1543
|
+
readonly Help_family: "Help family";
|
|
1544
|
+
readonly Other: "Other";
|
|
1545
|
+
};
|
|
1546
|
+
|
|
1547
|
+
/**
|
|
1548
|
+
* Generated by orval v7.21.0 🍺
|
|
1549
|
+
* Do not edit manually.
|
|
1550
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1551
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1552
|
+
|
|
1553
|
+
**Published:** 2026-08-18
|
|
1554
|
+
* OpenAPI spec version: 2026.16.1
|
|
1555
|
+
*/
|
|
1556
|
+
/**
|
|
1557
|
+
* Source of the credit report pull (also present inside applicant)
|
|
1558
|
+
*/
|
|
1559
|
+
type LeadApplicationCreditPullSource = typeof LeadApplicationCreditPullSource[keyof typeof LeadApplicationCreditPullSource];
|
|
1560
|
+
declare const LeadApplicationCreditPullSource: {
|
|
1561
|
+
readonly spinwheel: "spinwheel";
|
|
1562
|
+
readonly core: "core";
|
|
1563
|
+
};
|
|
1564
|
+
|
|
1565
|
+
/**
|
|
1566
|
+
* Generated by orval v7.21.0 🍺
|
|
1567
|
+
* Do not edit manually.
|
|
1568
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1569
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1570
|
+
|
|
1571
|
+
**Published:** 2026-08-18
|
|
1572
|
+
* OpenAPI spec version: 2026.16.1
|
|
1573
|
+
*/
|
|
1574
|
+
/**
|
|
1575
|
+
* Creditor or original creditor details
|
|
1576
|
+
*/
|
|
1577
|
+
interface LeadCreditor {
|
|
1578
|
+
/** Salesforce creditor record ID */
|
|
1579
|
+
id?: string;
|
|
1580
|
+
/** Creditor display name */
|
|
1581
|
+
name?: string;
|
|
1582
|
+
/** Aggressive settlement indicator */
|
|
1583
|
+
aggressive?: string;
|
|
1584
|
+
/** Creditor type */
|
|
1585
|
+
type?: string;
|
|
1069
1586
|
/** Creditor account status */
|
|
1070
1587
|
status?: string;
|
|
1071
1588
|
/** Alternative display name for the creditor (meta-creditor label) */
|
|
@@ -1089,7 +1606,9 @@ interface LeadCreditor {
|
|
|
1089
1606
|
* Do not edit manually.
|
|
1090
1607
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1091
1608
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1092
|
-
|
|
1609
|
+
|
|
1610
|
+
**Published:** 2026-08-18
|
|
1611
|
+
* OpenAPI spec version: 2026.16.1
|
|
1093
1612
|
*/
|
|
1094
1613
|
/**
|
|
1095
1614
|
* Responsibility type for the account
|
|
@@ -1099,6 +1618,13 @@ declare const LeadDebtAccountResponsibility: {
|
|
|
1099
1618
|
readonly individual: "individual";
|
|
1100
1619
|
readonly joint: "joint";
|
|
1101
1620
|
readonly 'authorized-user': "authorized-user";
|
|
1621
|
+
readonly 'co-signer': "co-signer";
|
|
1622
|
+
readonly business: "business";
|
|
1623
|
+
readonly 'on-behalf-of': "on-behalf-of";
|
|
1624
|
+
readonly signer: "signer";
|
|
1625
|
+
readonly deceased: "deceased";
|
|
1626
|
+
readonly terminated: "terminated";
|
|
1627
|
+
readonly undesignated: "undesignated";
|
|
1102
1628
|
};
|
|
1103
1629
|
|
|
1104
1630
|
/**
|
|
@@ -1106,7 +1632,9 @@ declare const LeadDebtAccountResponsibility: {
|
|
|
1106
1632
|
* Do not edit manually.
|
|
1107
1633
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1108
1634
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1109
|
-
|
|
1635
|
+
|
|
1636
|
+
**Published:** 2026-08-18
|
|
1637
|
+
* OpenAPI spec version: 2026.16.1
|
|
1110
1638
|
*/
|
|
1111
1639
|
/**
|
|
1112
1640
|
* Ownership of the account
|
|
@@ -1123,15 +1651,114 @@ declare const LeadDebtAccountOwnership: {
|
|
|
1123
1651
|
* Do not edit manually.
|
|
1124
1652
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1125
1653
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1126
|
-
|
|
1654
|
+
|
|
1655
|
+
**Published:** 2026-08-18
|
|
1656
|
+
* OpenAPI spec version: 2026.16.1
|
|
1127
1657
|
*/
|
|
1658
|
+
/**
|
|
1659
|
+
* Source of the debt account record
|
|
1660
|
+
*/
|
|
1661
|
+
type LeadDebtAccountSource = typeof LeadDebtAccountSource[keyof typeof LeadDebtAccountSource];
|
|
1662
|
+
declare const LeadDebtAccountSource: {
|
|
1663
|
+
readonly cbr: "cbr";
|
|
1664
|
+
readonly 'added-by-client': "added-by-client";
|
|
1665
|
+
readonly 'cbr-modified-by-client': "cbr-modified-by-client";
|
|
1666
|
+
readonly 'cbr-removed-by-client': "cbr-removed-by-client";
|
|
1667
|
+
readonly 'added-by-dc': "added-by-dc";
|
|
1668
|
+
};
|
|
1669
|
+
|
|
1670
|
+
/**
|
|
1671
|
+
* Generated by orval v7.21.0 🍺
|
|
1672
|
+
* Do not edit manually.
|
|
1673
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1674
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1675
|
+
|
|
1676
|
+
**Published:** 2026-08-18
|
|
1677
|
+
* OpenAPI spec version: 2026.16.1
|
|
1678
|
+
*/
|
|
1679
|
+
/**
|
|
1680
|
+
* Type of account
|
|
1681
|
+
*/
|
|
1682
|
+
type LeadDebtAccountAccountType = typeof LeadDebtAccountAccountType[keyof typeof LeadDebtAccountAccountType];
|
|
1683
|
+
declare const LeadDebtAccountAccountType: {
|
|
1684
|
+
readonly 'credit-card': "credit-card";
|
|
1685
|
+
readonly 'unsecured-loan': "unsecured-loan";
|
|
1686
|
+
readonly 'secured-debt': "secured-debt";
|
|
1687
|
+
readonly mortgage: "mortgage";
|
|
1688
|
+
readonly 'line-of-credit': "line-of-credit";
|
|
1689
|
+
readonly collections: "collections";
|
|
1690
|
+
readonly medical: "medical";
|
|
1691
|
+
readonly auto: "auto";
|
|
1692
|
+
readonly 'education-loan': "education-loan";
|
|
1693
|
+
readonly 'secured-credit-card': "secured-credit-card";
|
|
1694
|
+
readonly 'credit-union': "credit-union";
|
|
1695
|
+
readonly 'federal-credit-union': "federal-credit-union";
|
|
1696
|
+
readonly 'with-law-firm': "with-law-firm";
|
|
1697
|
+
readonly 'old-judgement': "old-judgement";
|
|
1698
|
+
readonly 'discontinued-service': "discontinued-service";
|
|
1699
|
+
readonly 'business-debt-other': "business-debt-other";
|
|
1700
|
+
readonly 'business-debt-credit-card': "business-debt-credit-card";
|
|
1701
|
+
readonly 'business-debt-loan': "business-debt-loan";
|
|
1702
|
+
readonly 'government-debt': "government-debt";
|
|
1703
|
+
readonly 'legal-fees': "legal-fees";
|
|
1704
|
+
};
|
|
1705
|
+
|
|
1706
|
+
/**
|
|
1707
|
+
* Generated by orval v7.21.0 🍺
|
|
1708
|
+
* Do not edit manually.
|
|
1709
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1710
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1711
|
+
|
|
1712
|
+
**Published:** 2026-08-18
|
|
1713
|
+
* OpenAPI spec version: 2026.16.1
|
|
1714
|
+
*/
|
|
1715
|
+
/**
|
|
1716
|
+
* Ineligibility reason identifier (PS_Id__c from PS_Evaluations_Config__mdt). See PgIneligibleReasonId for the full set of known values.
|
|
1717
|
+
*/
|
|
1718
|
+
type IneligibleReasonReasonId = typeof IneligibleReasonReasonId[keyof typeof IneligibleReasonReasonId];
|
|
1719
|
+
declare const IneligibleReasonReasonId: {
|
|
1720
|
+
readonly 'account-debt-too-low': "account-debt-too-low";
|
|
1721
|
+
readonly 'ca-ab1405-joint-debt-3rd-party': "ca-ab1405-joint-debt-3rd-party";
|
|
1722
|
+
readonly 'conflict-of-interest-ffam-cplus-balance': "conflict-of-interest-ffam-cplus-balance";
|
|
1723
|
+
readonly 'conflict-of-interest-ffam-fplus-balance': "conflict-of-interest-ffam-fplus-balance";
|
|
1724
|
+
readonly 'credit-union-cross-collateral': "credit-union-cross-collateral";
|
|
1725
|
+
readonly 'debt-too-low': "debt-too-low";
|
|
1726
|
+
readonly 'duplicate-account': "duplicate-account";
|
|
1727
|
+
readonly 'ineligible-applicants': "ineligible-applicants";
|
|
1728
|
+
readonly 'invalid-balance-date': "invalid-balance-date";
|
|
1729
|
+
readonly 'invalid-balance-date-percent-exceeded': "invalid-balance-date-percent-exceeded";
|
|
1730
|
+
readonly 'merchandise-account-too-new': "merchandise-account-too-new";
|
|
1731
|
+
readonly 'secured-loan': "secured-loan";
|
|
1732
|
+
readonly 'single-creditor-collection-debt-percent-exceeded': "single-creditor-collection-debt-percent-exceeded";
|
|
1733
|
+
readonly 'unacceptable-creditor': "unacceptable-creditor";
|
|
1734
|
+
readonly 'unacceptable-education': "unacceptable-education";
|
|
1735
|
+
readonly 'unacceptable-equipment': "unacceptable-equipment";
|
|
1736
|
+
readonly 'unacceptable-government': "unacceptable-government";
|
|
1737
|
+
readonly 'unacceptable-insurance': "unacceptable-insurance";
|
|
1738
|
+
readonly 'unacceptable-legal-fees': "unacceptable-legal-fees";
|
|
1739
|
+
readonly 'unacceptable-mortgage': "unacceptable-mortgage";
|
|
1740
|
+
readonly 'unacceptable-responsibility': "unacceptable-responsibility";
|
|
1741
|
+
readonly 'unacceptable-secured': "unacceptable-secured";
|
|
1742
|
+
readonly 'unacceptable-state': "unacceptable-state";
|
|
1743
|
+
};
|
|
1744
|
+
|
|
1745
|
+
/**
|
|
1746
|
+
* Generated by orval v7.21.0 🍺
|
|
1747
|
+
* Do not edit manually.
|
|
1748
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1749
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1750
|
+
|
|
1751
|
+
**Published:** 2026-08-18
|
|
1752
|
+
* OpenAPI spec version: 2026.16.1
|
|
1753
|
+
*/
|
|
1754
|
+
|
|
1128
1755
|
/**
|
|
1129
1756
|
* Ineligibility reason code wrapper
|
|
1130
1757
|
* @nullable
|
|
1131
1758
|
*/
|
|
1132
1759
|
type IneligibleReason = {
|
|
1133
|
-
/** Ineligibility reason identifier */
|
|
1134
|
-
reason_id?:
|
|
1760
|
+
/** Ineligibility reason identifier (PS_Id__c from PS_Evaluations_Config__mdt). See PgIneligibleReasonId for the full set of known values. */
|
|
1761
|
+
reason_id?: IneligibleReasonReasonId;
|
|
1135
1762
|
} | null;
|
|
1136
1763
|
|
|
1137
1764
|
/**
|
|
@@ -1139,7 +1766,9 @@ type IneligibleReason = {
|
|
|
1139
1766
|
* Do not edit manually.
|
|
1140
1767
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1141
1768
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1142
|
-
|
|
1769
|
+
|
|
1770
|
+
**Published:** 2026-08-18
|
|
1771
|
+
* OpenAPI spec version: 2026.16.1
|
|
1143
1772
|
*/
|
|
1144
1773
|
|
|
1145
1774
|
/**
|
|
@@ -1160,7 +1789,7 @@ interface LeadDebtAccount {
|
|
|
1160
1789
|
/** Ownership of the account */
|
|
1161
1790
|
ownership?: LeadDebtAccountOwnership;
|
|
1162
1791
|
/** Source of the debt account record */
|
|
1163
|
-
source?:
|
|
1792
|
+
source?: LeadDebtAccountSource;
|
|
1164
1793
|
/** Age / delinquency bucket of the debt */
|
|
1165
1794
|
aging?: string;
|
|
1166
1795
|
/** Rank assigned by DebtAccountRankingUtil (lower = higher priority) */
|
|
@@ -1199,7 +1828,7 @@ interface LeadDebtAccount {
|
|
|
1199
1828
|
/** Whether the account is active */
|
|
1200
1829
|
is_active?: string;
|
|
1201
1830
|
/** Type of account */
|
|
1202
|
-
account_type?:
|
|
1831
|
+
account_type?: LeadDebtAccountAccountType;
|
|
1203
1832
|
/** Sub-type of the account */
|
|
1204
1833
|
sub_account_type?: string;
|
|
1205
1834
|
/** Condition of the account */
|
|
@@ -1234,6 +1863,16 @@ interface LeadDebtAccount {
|
|
|
1234
1863
|
credit_utilization?: string;
|
|
1235
1864
|
/** Most recent delinquency bucket reported */
|
|
1236
1865
|
most_recent_delinquency?: string;
|
|
1866
|
+
/**
|
|
1867
|
+
* Credit bureau that reported this tradeline
|
|
1868
|
+
* @nullable
|
|
1869
|
+
*/
|
|
1870
|
+
tradeline_source?: string | null;
|
|
1871
|
+
/**
|
|
1872
|
+
* Universal identifier for the tradeline across credit bureaus
|
|
1873
|
+
* @nullable
|
|
1874
|
+
*/
|
|
1875
|
+
universal_id?: string | null;
|
|
1237
1876
|
/** First name of the joint account holder, if applicable */
|
|
1238
1877
|
joint_holder_first_name?: string;
|
|
1239
1878
|
/** Last name of the joint account holder, if applicable */
|
|
@@ -1258,8 +1897,31 @@ interface LeadDebtAccount {
|
|
|
1258
1897
|
* Do not edit manually.
|
|
1259
1898
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1260
1899
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1261
|
-
|
|
1900
|
+
|
|
1901
|
+
**Published:** 2026-08-18
|
|
1902
|
+
* OpenAPI spec version: 2026.16.1
|
|
1262
1903
|
*/
|
|
1904
|
+
/**
|
|
1905
|
+
* Tier label for this payment option
|
|
1906
|
+
* @nullable
|
|
1907
|
+
*/
|
|
1908
|
+
type PaymentOptionEvaluationType = typeof PaymentOptionEvaluationType[keyof typeof PaymentOptionEvaluationType] | null;
|
|
1909
|
+
declare const PaymentOptionEvaluationType: {
|
|
1910
|
+
readonly Most_Affordable: "Most Affordable";
|
|
1911
|
+
readonly Best_Value: "Best Value";
|
|
1912
|
+
readonly Fastest: "Fastest";
|
|
1913
|
+
};
|
|
1914
|
+
|
|
1915
|
+
/**
|
|
1916
|
+
* Generated by orval v7.21.0 🍺
|
|
1917
|
+
* Do not edit manually.
|
|
1918
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1919
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1920
|
+
|
|
1921
|
+
**Published:** 2026-08-18
|
|
1922
|
+
* OpenAPI spec version: 2026.16.1
|
|
1923
|
+
*/
|
|
1924
|
+
|
|
1263
1925
|
/**
|
|
1264
1926
|
* A single selectable payment option
|
|
1265
1927
|
* @nullable
|
|
@@ -1271,6 +1933,100 @@ type PaymentOption = {
|
|
|
1271
1933
|
program_cost?: number;
|
|
1272
1934
|
/** Program length for this option (months) */
|
|
1273
1935
|
program_length?: number;
|
|
1936
|
+
/**
|
|
1937
|
+
* Tier label for this payment option
|
|
1938
|
+
* @nullable
|
|
1939
|
+
*/
|
|
1940
|
+
evaluation_type?: PaymentOptionEvaluationType;
|
|
1941
|
+
} | null;
|
|
1942
|
+
|
|
1943
|
+
/**
|
|
1944
|
+
* Generated by orval v7.21.0 🍺
|
|
1945
|
+
* Do not edit manually.
|
|
1946
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1947
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1948
|
+
|
|
1949
|
+
**Published:** 2026-08-18
|
|
1950
|
+
* OpenAPI spec version: 2026.16.1
|
|
1951
|
+
*/
|
|
1952
|
+
/**
|
|
1953
|
+
* Draft frequency type
|
|
1954
|
+
*/
|
|
1955
|
+
type PaymentScheduleDraftType = typeof PaymentScheduleDraftType[keyof typeof PaymentScheduleDraftType];
|
|
1956
|
+
declare const PaymentScheduleDraftType: {
|
|
1957
|
+
readonly regular: "regular";
|
|
1958
|
+
readonly split: "split";
|
|
1959
|
+
readonly 'bi-weekly': "bi-weekly";
|
|
1960
|
+
};
|
|
1961
|
+
|
|
1962
|
+
/**
|
|
1963
|
+
* Generated by orval v7.21.0 🍺
|
|
1964
|
+
* Do not edit manually.
|
|
1965
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1966
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1967
|
+
|
|
1968
|
+
**Published:** 2026-08-18
|
|
1969
|
+
* OpenAPI spec version: 2026.16.1
|
|
1970
|
+
*/
|
|
1971
|
+
|
|
1972
|
+
/**
|
|
1973
|
+
* A single draft-frequency schedule within a payment schedule option
|
|
1974
|
+
*/
|
|
1975
|
+
interface PaymentSchedule {
|
|
1976
|
+
/** Schedule identifier */
|
|
1977
|
+
id?: string;
|
|
1978
|
+
/** Draft frequency type */
|
|
1979
|
+
draft_type?: PaymentScheduleDraftType;
|
|
1980
|
+
/** Draft deposit amount for this schedule (USD) */
|
|
1981
|
+
draft_deposit?: number;
|
|
1982
|
+
/** Effective monthly payment amount regardless of draft frequency (USD) */
|
|
1983
|
+
estimated_monthly_payment?: number;
|
|
1984
|
+
}
|
|
1985
|
+
|
|
1986
|
+
/**
|
|
1987
|
+
* Generated by orval v7.21.0 🍺
|
|
1988
|
+
* Do not edit manually.
|
|
1989
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1990
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1991
|
+
|
|
1992
|
+
**Published:** 2026-08-18
|
|
1993
|
+
* OpenAPI spec version: 2026.16.1
|
|
1994
|
+
*/
|
|
1995
|
+
/**
|
|
1996
|
+
* Tier label for this schedule option
|
|
1997
|
+
*/
|
|
1998
|
+
type PaymentScheduleOptionEvaluationType = typeof PaymentScheduleOptionEvaluationType[keyof typeof PaymentScheduleOptionEvaluationType];
|
|
1999
|
+
declare const PaymentScheduleOptionEvaluationType: {
|
|
2000
|
+
readonly Most_Affordable: "Most Affordable";
|
|
2001
|
+
readonly Best_Value: "Best Value";
|
|
2002
|
+
readonly Fastest: "Fastest";
|
|
2003
|
+
};
|
|
2004
|
+
|
|
2005
|
+
/**
|
|
2006
|
+
* Generated by orval v7.21.0 🍺
|
|
2007
|
+
* Do not edit manually.
|
|
2008
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
2009
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2010
|
+
|
|
2011
|
+
**Published:** 2026-08-18
|
|
2012
|
+
* OpenAPI spec version: 2026.16.1
|
|
2013
|
+
*/
|
|
2014
|
+
|
|
2015
|
+
/**
|
|
2016
|
+
* A payment tier with three draft-frequency schedule breakdowns
|
|
2017
|
+
* @nullable
|
|
2018
|
+
*/
|
|
2019
|
+
type PaymentScheduleOption = {
|
|
2020
|
+
/** Schedule option identifier */
|
|
2021
|
+
id?: string;
|
|
2022
|
+
/** Available draft schedules for this option (regular, split, bi-weekly) */
|
|
2023
|
+
schedules?: PaymentSchedule[];
|
|
2024
|
+
/** Tier label for this schedule option */
|
|
2025
|
+
evaluation_type?: PaymentScheduleOptionEvaluationType;
|
|
2026
|
+
/** Program length for this option (months) */
|
|
2027
|
+
program_length?: number;
|
|
2028
|
+
/** Total program cost for this option (USD) */
|
|
2029
|
+
program_cost?: number;
|
|
1274
2030
|
} | null;
|
|
1275
2031
|
|
|
1276
2032
|
/**
|
|
@@ -1278,7 +2034,9 @@ type PaymentOption = {
|
|
|
1278
2034
|
* Do not edit manually.
|
|
1279
2035
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1280
2036
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1281
|
-
|
|
2037
|
+
|
|
2038
|
+
**Published:** 2026-08-18
|
|
2039
|
+
* OpenAPI spec version: 2026.16.1
|
|
1282
2040
|
*/
|
|
1283
2041
|
|
|
1284
2042
|
/**
|
|
@@ -1286,11 +2044,11 @@ type PaymentOption = {
|
|
|
1286
2044
|
*/
|
|
1287
2045
|
interface LeadApplication {
|
|
1288
2046
|
/** Current program / opportunity stage */
|
|
1289
|
-
status?:
|
|
2047
|
+
status?: LeadApplicationStatus;
|
|
1290
2048
|
/** Program lifecycle state (e.g. Active, Closed, Cancelled) */
|
|
1291
2049
|
state?: string;
|
|
1292
2050
|
/** Client's preferred language */
|
|
1293
|
-
language?:
|
|
2051
|
+
language?: LeadApplicationLanguage;
|
|
1294
2052
|
/**
|
|
1295
2053
|
* Whether this application passed program eligibility checks
|
|
1296
2054
|
* @nullable
|
|
@@ -1311,7 +2069,7 @@ interface LeadApplication {
|
|
|
1311
2069
|
*/
|
|
1312
2070
|
conditions?: LeadCondition[] | null;
|
|
1313
2071
|
/** Sub-status of the current stage */
|
|
1314
|
-
sub_status?:
|
|
2072
|
+
sub_status?: LeadApplicationSubStatus;
|
|
1315
2073
|
/**
|
|
1316
2074
|
* DEX-specific flow status set by the partner integration
|
|
1317
2075
|
* @nullable
|
|
@@ -1408,7 +2166,7 @@ interface LeadApplication {
|
|
|
1408
2166
|
/** Monthly draft amount (USD) */
|
|
1409
2167
|
draft_amount?: number;
|
|
1410
2168
|
/** Draft frequency type */
|
|
1411
|
-
draft_type?:
|
|
2169
|
+
draft_type?: LeadApplicationDraftType;
|
|
1412
2170
|
/** Date of first programme draft (YYYY-MM-DD) */
|
|
1413
2171
|
first_draft_date?: string;
|
|
1414
2172
|
/** Second draft date for bi-weekly drafts (YYYY-MM-DD) */
|
|
@@ -1472,21 +2230,21 @@ interface LeadApplication {
|
|
|
1472
2230
|
/** Other expenses amount (numeric) */
|
|
1473
2231
|
other_expenses_describe?: number;
|
|
1474
2232
|
/** Primary hardship category */
|
|
1475
|
-
hardship_category?:
|
|
2233
|
+
hardship_category?: LeadApplicationHardshipCategory;
|
|
1476
2234
|
/**
|
|
1477
2235
|
* Free-text hardship description when category is 'Other'
|
|
1478
2236
|
* @nullable
|
|
1479
2237
|
*/
|
|
1480
2238
|
hardship_category_other?: string | null;
|
|
1481
2239
|
/** Client's primary financial goal category */
|
|
1482
|
-
goal_category?:
|
|
2240
|
+
goal_category?: LeadApplicationGoalCategory;
|
|
1483
2241
|
/**
|
|
1484
2242
|
* Free-text goal when category is 'Other'
|
|
1485
2243
|
* @nullable
|
|
1486
2244
|
*/
|
|
1487
2245
|
goal_category_other?: string | null;
|
|
1488
2246
|
/** Client's secondary financial goal */
|
|
1489
|
-
secondary_goal?:
|
|
2247
|
+
secondary_goal?: LeadApplicationSecondaryGoal;
|
|
1490
2248
|
/** Justification for housing cost amount */
|
|
1491
2249
|
housing_justification?: string;
|
|
1492
2250
|
/** Justification for transportation cost amount */
|
|
@@ -1594,6 +2352,11 @@ interface LeadApplication {
|
|
|
1594
2352
|
* @nullable
|
|
1595
2353
|
*/
|
|
1596
2354
|
payment_options?: PaymentOption[] | null;
|
|
2355
|
+
/**
|
|
2356
|
+
* 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.
|
|
2357
|
+
* @nullable
|
|
2358
|
+
*/
|
|
2359
|
+
payment_schedule_options?: PaymentScheduleOption[] | null;
|
|
1597
2360
|
bank_details?: BankDetails;
|
|
1598
2361
|
/**
|
|
1599
2362
|
* Reasons the application is ineligible, if any. Normalised from a comma-separated string to an array of reason objects.
|
|
@@ -1607,7 +2370,9 @@ interface LeadApplication {
|
|
|
1607
2370
|
* Do not edit manually.
|
|
1608
2371
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1609
2372
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1610
|
-
|
|
2373
|
+
|
|
2374
|
+
**Published:** 2026-08-18
|
|
2375
|
+
* OpenAPI spec version: 2026.16.1
|
|
1611
2376
|
*/
|
|
1612
2377
|
|
|
1613
2378
|
/**
|
|
@@ -1628,7 +2393,9 @@ interface CreateLeadResponse {
|
|
|
1628
2393
|
* Do not edit manually.
|
|
1629
2394
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1630
2395
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1631
|
-
|
|
2396
|
+
|
|
2397
|
+
**Published:** 2026-08-18
|
|
2398
|
+
* OpenAPI spec version: 2026.16.1
|
|
1632
2399
|
*/
|
|
1633
2400
|
/**
|
|
1634
2401
|
* Consent record for soft credit pull
|
|
@@ -1644,7 +2411,9 @@ type CreditPullConsent = {
|
|
|
1644
2411
|
* Do not edit manually.
|
|
1645
2412
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1646
2413
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1647
|
-
|
|
2414
|
+
|
|
2415
|
+
**Published:** 2026-08-18
|
|
2416
|
+
* OpenAPI spec version: 2026.16.1
|
|
1648
2417
|
*/
|
|
1649
2418
|
/**
|
|
1650
2419
|
* Applicant signing URL details
|
|
@@ -1659,7 +2428,9 @@ interface DraApplicant {
|
|
|
1659
2428
|
* Do not edit manually.
|
|
1660
2429
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1661
2430
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1662
|
-
|
|
2431
|
+
|
|
2432
|
+
**Published:** 2026-08-18
|
|
2433
|
+
* OpenAPI spec version: 2026.16.1
|
|
1663
2434
|
*/
|
|
1664
2435
|
/**
|
|
1665
2436
|
* DocuSign signing method. Use 'url' for embedded signing, 'email' for standard email signing.
|
|
@@ -1675,7 +2446,9 @@ declare const DraApplicantInputSigningType: {
|
|
|
1675
2446
|
* Do not edit manually.
|
|
1676
2447
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1677
2448
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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
|
-
|
|
2449
|
+
|
|
2450
|
+
**Published:** 2026-08-18
|
|
2451
|
+
* OpenAPI spec version: 2026.16.1
|
|
1679
2452
|
*/
|
|
1680
2453
|
|
|
1681
2454
|
/**
|
|
@@ -1691,7 +2464,9 @@ interface DraApplicantInput {
|
|
|
1691
2464
|
* Do not edit manually.
|
|
1692
2465
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1693
2466
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1694
|
-
|
|
2467
|
+
|
|
2468
|
+
**Published:** 2026-08-18
|
|
2469
|
+
* OpenAPI spec version: 2026.16.1
|
|
1695
2470
|
*/
|
|
1696
2471
|
|
|
1697
2472
|
/**
|
|
@@ -1708,7 +2483,9 @@ interface DraRequest {
|
|
|
1708
2483
|
* Do not edit manually.
|
|
1709
2484
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1710
2485
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1711
|
-
|
|
2486
|
+
|
|
2487
|
+
**Published:** 2026-08-18
|
|
2488
|
+
* OpenAPI spec version: 2026.16.1
|
|
1712
2489
|
*/
|
|
1713
2490
|
|
|
1714
2491
|
/**
|
|
@@ -1725,7 +2502,9 @@ interface DraResponse {
|
|
|
1725
2502
|
* Do not edit manually.
|
|
1726
2503
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1727
2504
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1728
|
-
|
|
2505
|
+
|
|
2506
|
+
**Published:** 2026-08-18
|
|
2507
|
+
* OpenAPI spec version: 2026.16.1
|
|
1729
2508
|
*/
|
|
1730
2509
|
/**
|
|
1731
2510
|
* Address for eligibility request
|
|
@@ -1748,7 +2527,9 @@ interface EligibilityAddress {
|
|
|
1748
2527
|
* Do not edit manually.
|
|
1749
2528
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1750
2529
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1751
|
-
|
|
2530
|
+
|
|
2531
|
+
**Published:** 2026-08-18
|
|
2532
|
+
* OpenAPI spec version: 2026.16.1
|
|
1752
2533
|
*/
|
|
1753
2534
|
|
|
1754
2535
|
/**
|
|
@@ -1775,7 +2556,9 @@ interface EligibilityApplicant {
|
|
|
1775
2556
|
* Do not edit manually.
|
|
1776
2557
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1777
2558
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1778
|
-
|
|
2559
|
+
|
|
2560
|
+
**Published:** 2026-08-18
|
|
2561
|
+
* OpenAPI spec version: 2026.16.1
|
|
1779
2562
|
*/
|
|
1780
2563
|
|
|
1781
2564
|
/**
|
|
@@ -1787,6 +2570,11 @@ interface EligibilityApplication {
|
|
|
1787
2570
|
debt_accounts?: LeadDebtAccount[];
|
|
1788
2571
|
/** Selectable payment options (3 tiers) */
|
|
1789
2572
|
payment_options?: PaymentOption[];
|
|
2573
|
+
/**
|
|
2574
|
+
* 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.
|
|
2575
|
+
* @nullable
|
|
2576
|
+
*/
|
|
2577
|
+
payment_schedule_options?: PaymentScheduleOption[] | null;
|
|
1790
2578
|
/** Total enrolled debt (USD) */
|
|
1791
2579
|
estimated_total_debt?: number;
|
|
1792
2580
|
/** Total cost if no action taken (USD) */
|
|
@@ -1854,7 +2642,9 @@ interface EligibilityApplication {
|
|
|
1854
2642
|
* Do not edit manually.
|
|
1855
2643
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1856
2644
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1857
|
-
|
|
2645
|
+
|
|
2646
|
+
**Published:** 2026-08-18
|
|
2647
|
+
* OpenAPI spec version: 2026.16.1
|
|
1858
2648
|
*/
|
|
1859
2649
|
/**
|
|
1860
2650
|
* Debt account entry for eligibility check (no-credit-pull path)
|
|
@@ -1894,7 +2684,9 @@ type EligibilityDebtAccount = {
|
|
|
1894
2684
|
* Do not edit manually.
|
|
1895
2685
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1896
2686
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1897
|
-
|
|
2687
|
+
|
|
2688
|
+
**Published:** 2026-08-18
|
|
2689
|
+
* OpenAPI spec version: 2026.16.1
|
|
1898
2690
|
*/
|
|
1899
2691
|
|
|
1900
2692
|
/**
|
|
@@ -1916,7 +2708,9 @@ interface EligibilityRequest {
|
|
|
1916
2708
|
* Do not edit manually.
|
|
1917
2709
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1918
2710
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1919
|
-
|
|
2711
|
+
|
|
2712
|
+
**Published:** 2026-08-18
|
|
2713
|
+
* OpenAPI spec version: 2026.16.1
|
|
1920
2714
|
*/
|
|
1921
2715
|
|
|
1922
2716
|
/**
|
|
@@ -1935,63 +2729,9 @@ interface EligibilityResponse {
|
|
|
1935
2729
|
* Do not edit manually.
|
|
1936
2730
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1937
2731
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1938
|
-
* OpenAPI spec version: 2026.15.0
|
|
1939
|
-
*/
|
|
1940
|
-
/**
|
|
1941
|
-
* Gate type identifier
|
|
1942
|
-
*/
|
|
1943
|
-
type ReadinessCheckType = typeof ReadinessCheckType[keyof typeof ReadinessCheckType];
|
|
1944
|
-
declare const ReadinessCheckType: {
|
|
1945
|
-
readonly uw_submission: "uw_submission";
|
|
1946
|
-
readonly dra: "dra";
|
|
1947
|
-
};
|
|
1948
2732
|
|
|
1949
|
-
|
|
1950
|
-
*
|
|
1951
|
-
* Do not edit manually.
|
|
1952
|
-
* ARPC — Achieve Resolution Partner Connect API
|
|
1953
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1954
|
-
* OpenAPI spec version: 2026.15.0
|
|
1955
|
-
*/
|
|
1956
|
-
|
|
1957
|
-
/**
|
|
1958
|
-
* Result of a single readiness gate check
|
|
1959
|
-
*/
|
|
1960
|
-
interface ReadinessCheck {
|
|
1961
|
-
/** Gate type identifier */
|
|
1962
|
-
type?: ReadinessCheckType;
|
|
1963
|
-
/** Whether this gate passed */
|
|
1964
|
-
verified?: boolean;
|
|
1965
|
-
/** Validation errors for this gate, if any */
|
|
1966
|
-
errors?: string[];
|
|
1967
|
-
}
|
|
1968
|
-
|
|
1969
|
-
/**
|
|
1970
|
-
* Generated by orval v7.21.0 🍺
|
|
1971
|
-
* Do not edit manually.
|
|
1972
|
-
* ARPC — Achieve Resolution Partner Connect API
|
|
1973
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1974
|
-
* OpenAPI spec version: 2026.15.0
|
|
1975
|
-
*/
|
|
1976
|
-
|
|
1977
|
-
/**
|
|
1978
|
-
* Readiness check breakdown
|
|
1979
|
-
*/
|
|
1980
|
-
interface ErrorDetails {
|
|
1981
|
-
/** Per-gate check results */
|
|
1982
|
-
checks?: ReadinessCheck[];
|
|
1983
|
-
/** Whether a program refresh is required before re-submission */
|
|
1984
|
-
is_program_refresh_required?: boolean;
|
|
1985
|
-
/** Whether the application is currently UW-approved */
|
|
1986
|
-
is_uw_approved?: boolean;
|
|
1987
|
-
}
|
|
1988
|
-
|
|
1989
|
-
/**
|
|
1990
|
-
* Generated by orval v7.21.0 🍺
|
|
1991
|
-
* Do not edit manually.
|
|
1992
|
-
* ARPC — Achieve Resolution Partner Connect API
|
|
1993
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1994
|
-
* OpenAPI spec version: 2026.15.0
|
|
2733
|
+
**Published:** 2026-08-18
|
|
2734
|
+
* OpenAPI spec version: 2026.16.1
|
|
1995
2735
|
*/
|
|
1996
2736
|
/**
|
|
1997
2737
|
* Address — used for current and mailing address updates
|
|
@@ -2014,7 +2754,9 @@ interface PatchAddress {
|
|
|
2014
2754
|
* Do not edit manually.
|
|
2015
2755
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2016
2756
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2017
|
-
|
|
2757
|
+
|
|
2758
|
+
**Published:** 2026-08-18
|
|
2759
|
+
* OpenAPI spec version: 2026.16.1
|
|
2018
2760
|
*/
|
|
2019
2761
|
|
|
2020
2762
|
/**
|
|
@@ -2084,7 +2826,51 @@ interface PatchApplicant {
|
|
|
2084
2826
|
* Do not edit manually.
|
|
2085
2827
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2086
2828
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2087
|
-
|
|
2829
|
+
|
|
2830
|
+
**Published:** 2026-08-18
|
|
2831
|
+
* OpenAPI spec version: 2026.16.1
|
|
2832
|
+
*/
|
|
2833
|
+
/**
|
|
2834
|
+
* Hardship category
|
|
2835
|
+
*/
|
|
2836
|
+
type LeadPatchRequestHardshipCategory = typeof LeadPatchRequestHardshipCategory[keyof typeof LeadPatchRequestHardshipCategory];
|
|
2837
|
+
declare const LeadPatchRequestHardshipCategory: {
|
|
2838
|
+
readonly Job_Loss: "Job Loss";
|
|
2839
|
+
readonly Reduced_Income: "Reduced Income";
|
|
2840
|
+
readonly Medical: "Medical";
|
|
2841
|
+
readonly Divorce: "Divorce";
|
|
2842
|
+
readonly Unexpected_Expenses: "Unexpected Expenses";
|
|
2843
|
+
readonly Other: "Other";
|
|
2844
|
+
};
|
|
2845
|
+
|
|
2846
|
+
/**
|
|
2847
|
+
* Generated by orval v7.21.0 🍺
|
|
2848
|
+
* Do not edit manually.
|
|
2849
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
2850
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2851
|
+
|
|
2852
|
+
**Published:** 2026-08-18
|
|
2853
|
+
* OpenAPI spec version: 2026.16.1
|
|
2854
|
+
*/
|
|
2855
|
+
/**
|
|
2856
|
+
* Goal category
|
|
2857
|
+
*/
|
|
2858
|
+
type LeadPatchRequestGoalCategory = typeof LeadPatchRequestGoalCategory[keyof typeof LeadPatchRequestGoalCategory];
|
|
2859
|
+
declare const LeadPatchRequestGoalCategory: {
|
|
2860
|
+
readonly Avoid_Bankruptcy: "Avoid Bankruptcy";
|
|
2861
|
+
readonly Get_out_of_Debt: "Get out of Debt";
|
|
2862
|
+
readonly 'Build_personal_wealth,_savings': "Build personal wealth, savings";
|
|
2863
|
+
readonly Relieve_pressure_of_monthly_bills: "Relieve pressure of monthly bills";
|
|
2864
|
+
};
|
|
2865
|
+
|
|
2866
|
+
/**
|
|
2867
|
+
* Generated by orval v7.21.0 🍺
|
|
2868
|
+
* Do not edit manually.
|
|
2869
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
2870
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2871
|
+
|
|
2872
|
+
**Published:** 2026-08-18
|
|
2873
|
+
* OpenAPI spec version: 2026.16.1
|
|
2088
2874
|
*/
|
|
2089
2875
|
/**
|
|
2090
2876
|
* Condition to verify (lead-level or debt-account-level)
|
|
@@ -2103,7 +2889,9 @@ interface PatchCondition {
|
|
|
2103
2889
|
* Do not edit manually.
|
|
2104
2890
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2105
2891
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2106
|
-
|
|
2892
|
+
|
|
2893
|
+
**Published:** 2026-08-18
|
|
2894
|
+
* OpenAPI spec version: 2026.16.1
|
|
2107
2895
|
*/
|
|
2108
2896
|
|
|
2109
2897
|
/**
|
|
@@ -2125,7 +2913,9 @@ interface PatchDebtAccount {
|
|
|
2125
2913
|
* Do not edit manually.
|
|
2126
2914
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2127
2915
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2128
|
-
|
|
2916
|
+
|
|
2917
|
+
**Published:** 2026-08-18
|
|
2918
|
+
* OpenAPI spec version: 2026.16.1
|
|
2129
2919
|
*/
|
|
2130
2920
|
/**
|
|
2131
2921
|
* Co-applicant fields that can be patched
|
|
@@ -2184,7 +2974,9 @@ interface PatchCoApplicant {
|
|
|
2184
2974
|
* Do not edit manually.
|
|
2185
2975
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2186
2976
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2187
|
-
|
|
2977
|
+
|
|
2978
|
+
**Published:** 2026-08-18
|
|
2979
|
+
* OpenAPI spec version: 2026.16.1
|
|
2188
2980
|
*/
|
|
2189
2981
|
|
|
2190
2982
|
/**
|
|
@@ -2198,12 +2990,14 @@ interface LeadPatchRequest {
|
|
|
2198
2990
|
rent_or_mortgage_monthly?: number;
|
|
2199
2991
|
/** Desired monthly deposit amount */
|
|
2200
2992
|
monthly_deposit?: number;
|
|
2993
|
+
/** Second draft date for split (twice-monthly) drafts (YYYY-MM-DD). Set this after UW submission and before generating the DRA. For bi-weekly drafts, second_draft_date_bi_weekly is populated automatically during UW approval. */
|
|
2994
|
+
second_draft_date_split?: string;
|
|
2201
2995
|
/** Hardship category */
|
|
2202
|
-
hardship_category?:
|
|
2996
|
+
hardship_category?: LeadPatchRequestHardshipCategory;
|
|
2203
2997
|
/** Free-text hardship description when category is 'Other' */
|
|
2204
2998
|
hardship_category_other?: string;
|
|
2205
2999
|
/** Goal category */
|
|
2206
|
-
goal_category?:
|
|
3000
|
+
goal_category?: LeadPatchRequestGoalCategory;
|
|
2207
3001
|
/** Free-text goal description when category is 'Other' */
|
|
2208
3002
|
goal_category_other?: string;
|
|
2209
3003
|
/** Monthly food expenses */
|
|
@@ -2284,7 +3078,9 @@ interface LeadPatchRequest {
|
|
|
2284
3078
|
* Do not edit manually.
|
|
2285
3079
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2286
3080
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2287
|
-
|
|
3081
|
+
|
|
3082
|
+
**Published:** 2026-08-18
|
|
3083
|
+
* OpenAPI spec version: 2026.16.1
|
|
2288
3084
|
*/
|
|
2289
3085
|
|
|
2290
3086
|
/**
|
|
@@ -2311,7 +3107,9 @@ type LeadReadiness = {
|
|
|
2311
3107
|
* Do not edit manually.
|
|
2312
3108
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2313
3109
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2314
|
-
|
|
3110
|
+
|
|
3111
|
+
**Published:** 2026-08-18
|
|
3112
|
+
* OpenAPI spec version: 2026.16.1
|
|
2315
3113
|
*/
|
|
2316
3114
|
|
|
2317
3115
|
/**
|
|
@@ -2331,7 +3129,9 @@ interface LeadResponse {
|
|
|
2331
3129
|
* Do not edit manually.
|
|
2332
3130
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2333
3131
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2334
|
-
|
|
3132
|
+
|
|
3133
|
+
**Published:** 2026-08-18
|
|
3134
|
+
* OpenAPI spec version: 2026.16.1
|
|
2335
3135
|
*/
|
|
2336
3136
|
/**
|
|
2337
3137
|
* Applicant mailing address.
|
|
@@ -2352,7 +3152,9 @@ interface MailingAddress {
|
|
|
2352
3152
|
* Do not edit manually.
|
|
2353
3153
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2354
3154
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2355
|
-
|
|
3155
|
+
|
|
3156
|
+
**Published:** 2026-08-18
|
|
3157
|
+
* OpenAPI spec version: 2026.16.1
|
|
2356
3158
|
*/
|
|
2357
3159
|
/**
|
|
2358
3160
|
* Marketing tracking metadata
|
|
@@ -2371,7 +3173,9 @@ interface Tracking {
|
|
|
2371
3173
|
* Do not edit manually.
|
|
2372
3174
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2373
3175
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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
|
-
|
|
3176
|
+
|
|
3177
|
+
**Published:** 2026-08-18
|
|
3178
|
+
* OpenAPI spec version: 2026.16.1
|
|
2375
3179
|
*/
|
|
2376
3180
|
|
|
2377
3181
|
/**
|
|
@@ -2404,7 +3208,9 @@ interface LeadTransferRequest {
|
|
|
2404
3208
|
* Do not edit manually.
|
|
2405
3209
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2406
3210
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2407
|
-
|
|
3211
|
+
|
|
3212
|
+
**Published:** 2026-08-18
|
|
3213
|
+
* OpenAPI spec version: 2026.16.1
|
|
2408
3214
|
*/
|
|
2409
3215
|
/**
|
|
2410
3216
|
* Evaluation outcome: 'accepted' or 'rejected'.
|
|
@@ -2420,7 +3226,9 @@ declare const LeadTransferResponseResponse: {
|
|
|
2420
3226
|
* Do not edit manually.
|
|
2421
3227
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2422
3228
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2423
|
-
|
|
3229
|
+
|
|
3230
|
+
**Published:** 2026-08-18
|
|
3231
|
+
* OpenAPI spec version: 2026.16.1
|
|
2424
3232
|
*/
|
|
2425
3233
|
|
|
2426
3234
|
/**
|
|
@@ -2463,7 +3271,9 @@ interface LeadTransferResponse {
|
|
|
2463
3271
|
* Do not edit manually.
|
|
2464
3272
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2465
3273
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2466
|
-
|
|
3274
|
+
|
|
3275
|
+
**Published:** 2026-08-18
|
|
3276
|
+
* OpenAPI spec version: 2026.16.1
|
|
2467
3277
|
*/
|
|
2468
3278
|
/**
|
|
2469
3279
|
* Request body for async program generation (v1)
|
|
@@ -2480,7 +3290,68 @@ interface ProgramRequest {
|
|
|
2480
3290
|
* Do not edit manually.
|
|
2481
3291
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2482
3292
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2483
|
-
|
|
3293
|
+
|
|
3294
|
+
**Published:** 2026-08-18
|
|
3295
|
+
* OpenAPI spec version: 2026.16.1
|
|
3296
|
+
*/
|
|
3297
|
+
/**
|
|
3298
|
+
* Minimal applicant reference identifying the lead
|
|
3299
|
+
|
|
3300
|
+
⚠️ Patched locally by `openapi/repairs.ts` — this differs from FDR's published spec.
|
|
3301
|
+
*/
|
|
3302
|
+
interface ProgramSelectionApplicant {
|
|
3303
|
+
/** The unique FDR applicant ID of the lead */
|
|
3304
|
+
fdr_applicant_id: string;
|
|
3305
|
+
}
|
|
3306
|
+
|
|
3307
|
+
/**
|
|
3308
|
+
* Generated by orval v7.21.0 🍺
|
|
3309
|
+
* Do not edit manually.
|
|
3310
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
3311
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3312
|
+
|
|
3313
|
+
**Published:** 2026-08-18
|
|
3314
|
+
* OpenAPI spec version: 2026.16.1
|
|
3315
|
+
*/
|
|
3316
|
+
/**
|
|
3317
|
+
* Selected draft schedule type from payment_schedule_options
|
|
3318
|
+
*/
|
|
3319
|
+
type ProgramSelectionRequestDraftType = typeof ProgramSelectionRequestDraftType[keyof typeof ProgramSelectionRequestDraftType];
|
|
3320
|
+
declare const ProgramSelectionRequestDraftType: {
|
|
3321
|
+
readonly regular: "regular";
|
|
3322
|
+
readonly split: "split";
|
|
3323
|
+
readonly 'bi-weekly': "bi-weekly";
|
|
3324
|
+
};
|
|
3325
|
+
|
|
3326
|
+
/**
|
|
3327
|
+
* Generated by orval v7.21.0 🍺
|
|
3328
|
+
* Do not edit manually.
|
|
3329
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
3330
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3331
|
+
|
|
3332
|
+
**Published:** 2026-08-18
|
|
3333
|
+
* OpenAPI spec version: 2026.16.1
|
|
3334
|
+
*/
|
|
3335
|
+
|
|
3336
|
+
/**
|
|
3337
|
+
* Request body for selecting a payment schedule for an existing lead
|
|
3338
|
+
*/
|
|
3339
|
+
interface ProgramSelectionRequest {
|
|
3340
|
+
applicant: ProgramSelectionApplicant;
|
|
3341
|
+
/** Selected draft schedule type from payment_schedule_options */
|
|
3342
|
+
draft_type?: ProgramSelectionRequestDraftType;
|
|
3343
|
+
/** The estimated_monthly_payment value from the chosen payment_schedule_options[].schedules[] entry */
|
|
3344
|
+
estimated_monthly_payment?: number;
|
|
3345
|
+
}
|
|
3346
|
+
|
|
3347
|
+
/**
|
|
3348
|
+
* Generated by orval v7.21.0 🍺
|
|
3349
|
+
* Do not edit manually.
|
|
3350
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
3351
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3352
|
+
|
|
3353
|
+
**Published:** 2026-08-18
|
|
3354
|
+
* OpenAPI spec version: 2026.16.1
|
|
2484
3355
|
*/
|
|
2485
3356
|
/**
|
|
2486
3357
|
* Request body for creating a Program Summary Recording task (RWA-2427)
|
|
@@ -2505,7 +3376,9 @@ interface ProgramSummaryTaskRequest {
|
|
|
2505
3376
|
* Do not edit manually.
|
|
2506
3377
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2507
3378
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2508
|
-
|
|
3379
|
+
|
|
3380
|
+
**Published:** 2026-08-18
|
|
3381
|
+
* OpenAPI spec version: 2026.16.1
|
|
2509
3382
|
*/
|
|
2510
3383
|
/**
|
|
2511
3384
|
* Response body for a successfully created Program Summary Recording task
|
|
@@ -2530,48 +3403,9 @@ interface ProgramSummaryTaskResponse {
|
|
|
2530
3403
|
* Do not edit manually.
|
|
2531
3404
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2532
3405
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2533
|
-
* OpenAPI spec version: 2026.15.0
|
|
2534
|
-
*/
|
|
2535
|
-
/**
|
|
2536
|
-
* Error classification code
|
|
2537
|
-
*/
|
|
2538
|
-
type ReadinessErrorResponseErrorCode = typeof ReadinessErrorResponseErrorCode[keyof typeof ReadinessErrorResponseErrorCode];
|
|
2539
|
-
declare const ReadinessErrorResponseErrorCode: {
|
|
2540
|
-
readonly ER40301: "ER40301";
|
|
2541
|
-
readonly ER40305: "ER40305";
|
|
2542
|
-
};
|
|
2543
|
-
|
|
2544
|
-
/**
|
|
2545
|
-
* Generated by orval v7.21.0 🍺
|
|
2546
|
-
* Do not edit manually.
|
|
2547
|
-
* ARPC — Achieve Resolution Partner Connect API
|
|
2548
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2549
|
-
* OpenAPI spec version: 2026.15.0
|
|
2550
|
-
*/
|
|
2551
|
-
|
|
2552
|
-
/**
|
|
2553
|
-
* Error response for readiness gate failures. Includes per-check detail for UW and DRA gates.
|
|
2554
|
-
*/
|
|
2555
|
-
interface ReadinessErrorResponse {
|
|
2556
|
-
/** UTC timestamp of the error */
|
|
2557
|
-
timestamp?: string;
|
|
2558
|
-
/** HTTP status code */
|
|
2559
|
-
status?: number;
|
|
2560
|
-
/** Short error message */
|
|
2561
|
-
error?: string;
|
|
2562
|
-
/** Error classification code */
|
|
2563
|
-
error_code?: ReadinessErrorResponseErrorCode;
|
|
2564
|
-
/** Correlation ID for distributed tracing */
|
|
2565
|
-
x_correlation_id?: string;
|
|
2566
|
-
error_details?: ErrorDetails;
|
|
2567
|
-
}
|
|
2568
3406
|
|
|
2569
|
-
|
|
2570
|
-
*
|
|
2571
|
-
* Do not edit manually.
|
|
2572
|
-
* ARPC — Achieve Resolution Partner Connect API
|
|
2573
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2574
|
-
* OpenAPI spec version: 2026.15.0
|
|
3407
|
+
**Published:** 2026-08-18
|
|
3408
|
+
* OpenAPI spec version: 2026.16.1
|
|
2575
3409
|
*/
|
|
2576
3410
|
|
|
2577
3411
|
/**
|
|
@@ -2597,18 +3431,18 @@ interface ReadinessResponse {
|
|
|
2597
3431
|
* Do not edit manually.
|
|
2598
3432
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2599
3433
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2600
|
-
|
|
3434
|
+
|
|
3435
|
+
**Published:** 2026-08-18
|
|
3436
|
+
* OpenAPI spec version: 2026.16.1
|
|
2601
3437
|
*/
|
|
3438
|
+
|
|
2602
3439
|
/**
|
|
2603
|
-
*
|
|
3440
|
+
* Request body for registering a new applicant in the v2 DEX surface
|
|
2604
3441
|
*/
|
|
2605
|
-
interface
|
|
2606
|
-
/**
|
|
2607
|
-
|
|
2608
|
-
|
|
2609
|
-
business_flow?: string;
|
|
2610
|
-
/** Salesforce ID of the created achieve__Applicant__c record */
|
|
2611
|
-
salesforce_id?: string;
|
|
3442
|
+
interface RegisterApplicantV2Request {
|
|
3443
|
+
/** Email of the seller agent to be set as the Salesforce record owner */
|
|
3444
|
+
seller_agent_email?: string;
|
|
3445
|
+
applicant: Applicant;
|
|
2612
3446
|
}
|
|
2613
3447
|
|
|
2614
3448
|
/**
|
|
@@ -2616,16 +3450,22 @@ interface RegisterApplicantResponse {
|
|
|
2616
3450
|
* Do not edit manually.
|
|
2617
3451
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2618
3452
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2619
|
-
* OpenAPI spec version: 2026.15.0
|
|
2620
|
-
*/
|
|
2621
3453
|
|
|
3454
|
+
**Published:** 2026-08-18
|
|
3455
|
+
* OpenAPI spec version: 2026.16.1
|
|
3456
|
+
*/
|
|
2622
3457
|
/**
|
|
2623
|
-
*
|
|
3458
|
+
* Response returned after successfully registering an applicant via POST /v2/applicant/register
|
|
2624
3459
|
*/
|
|
2625
|
-
interface
|
|
2626
|
-
/**
|
|
2627
|
-
|
|
2628
|
-
|
|
3460
|
+
interface RegisterApplicantV2Response {
|
|
3461
|
+
/** Registration status */
|
|
3462
|
+
status?: string;
|
|
3463
|
+
/** Business flow / seller identifier derived from the OAuth token used (e.g. SSI, TTTM) */
|
|
3464
|
+
business_flow?: string;
|
|
3465
|
+
/** Salesforce ID of the created achieve__Applicant__c record */
|
|
3466
|
+
salesforce_id?: string;
|
|
3467
|
+
/** FDR applicant ID associated with this registration. If not provided in the request, it is generated server-side and returned here. */
|
|
3468
|
+
fdr_applicant_id?: string;
|
|
2629
3469
|
}
|
|
2630
3470
|
|
|
2631
3471
|
/**
|
|
@@ -2633,7 +3473,9 @@ interface RegisterApplicantV2Request {
|
|
|
2633
3473
|
* Do not edit manually.
|
|
2634
3474
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2635
3475
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2636
|
-
|
|
3476
|
+
|
|
3477
|
+
**Published:** 2026-08-18
|
|
3478
|
+
* OpenAPI spec version: 2026.16.1
|
|
2637
3479
|
*/
|
|
2638
3480
|
|
|
2639
3481
|
/**
|
|
@@ -2658,7 +3500,9 @@ interface SpinwheelNetworkUserRequest {
|
|
|
2658
3500
|
* Do not edit manually.
|
|
2659
3501
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2660
3502
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2661
|
-
|
|
3503
|
+
|
|
3504
|
+
**Published:** 2026-08-18
|
|
3505
|
+
* OpenAPI spec version: 2026.16.1
|
|
2662
3506
|
*/
|
|
2663
3507
|
/**
|
|
2664
3508
|
* Result of creating or connecting a Spinwheel network user
|
|
@@ -2675,7 +3519,51 @@ interface SpinwheelNetworkUserResponse {
|
|
|
2675
3519
|
* Do not edit manually.
|
|
2676
3520
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2677
3521
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2678
|
-
|
|
3522
|
+
|
|
3523
|
+
**Published:** 2026-08-18
|
|
3524
|
+
* OpenAPI spec version: 2026.16.1
|
|
3525
|
+
*/
|
|
3526
|
+
/**
|
|
3527
|
+
* Primary hardship category
|
|
3528
|
+
*/
|
|
3529
|
+
type StatelessReadinessRequestHardshipCategory = typeof StatelessReadinessRequestHardshipCategory[keyof typeof StatelessReadinessRequestHardshipCategory];
|
|
3530
|
+
declare const StatelessReadinessRequestHardshipCategory: {
|
|
3531
|
+
readonly Job_Loss: "Job Loss";
|
|
3532
|
+
readonly Reduced_Income: "Reduced Income";
|
|
3533
|
+
readonly Medical: "Medical";
|
|
3534
|
+
readonly Divorce: "Divorce";
|
|
3535
|
+
readonly Unexpected_Expenses: "Unexpected Expenses";
|
|
3536
|
+
readonly Other: "Other";
|
|
3537
|
+
};
|
|
3538
|
+
|
|
3539
|
+
/**
|
|
3540
|
+
* Generated by orval v7.21.0 🍺
|
|
3541
|
+
* Do not edit manually.
|
|
3542
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
3544
|
+
|
|
3545
|
+
**Published:** 2026-08-18
|
|
3546
|
+
* OpenAPI spec version: 2026.16.1
|
|
3547
|
+
*/
|
|
3548
|
+
/**
|
|
3549
|
+
* Primary goal category
|
|
3550
|
+
*/
|
|
3551
|
+
type StatelessReadinessRequestGoalCategory = typeof StatelessReadinessRequestGoalCategory[keyof typeof StatelessReadinessRequestGoalCategory];
|
|
3552
|
+
declare const StatelessReadinessRequestGoalCategory: {
|
|
3553
|
+
readonly Avoid_Bankruptcy: "Avoid Bankruptcy";
|
|
3554
|
+
readonly Get_out_of_Debt: "Get out of Debt";
|
|
3555
|
+
readonly 'Build_personal_wealth,_savings': "Build personal wealth, savings";
|
|
3556
|
+
readonly Relieve_pressure_of_monthly_bills: "Relieve pressure of monthly bills";
|
|
3557
|
+
};
|
|
3558
|
+
|
|
3559
|
+
/**
|
|
3560
|
+
* Generated by orval v7.21.0 🍺
|
|
3561
|
+
* Do not edit manually.
|
|
3562
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
3563
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3564
|
+
|
|
3565
|
+
**Published:** 2026-08-18
|
|
3566
|
+
* OpenAPI spec version: 2026.16.1
|
|
2679
3567
|
*/
|
|
2680
3568
|
|
|
2681
3569
|
/**
|
|
@@ -2715,11 +3603,11 @@ interface StatelessReadinessRequest {
|
|
|
2715
3603
|
/** Total business debt amount */
|
|
2716
3604
|
business_debt?: number;
|
|
2717
3605
|
/** Primary hardship category */
|
|
2718
|
-
hardship_category?:
|
|
3606
|
+
hardship_category?: StatelessReadinessRequestHardshipCategory;
|
|
2719
3607
|
/** Free-text description when hardship category is 'other' */
|
|
2720
3608
|
hardship_category_other?: string;
|
|
2721
3609
|
/** Primary goal category */
|
|
2722
|
-
goal_category?:
|
|
3610
|
+
goal_category?: StatelessReadinessRequestGoalCategory;
|
|
2723
3611
|
/** Free-text description when goal category is 'other' */
|
|
2724
3612
|
goal_category_other?: string;
|
|
2725
3613
|
/** Justification for food expense amount */
|
|
@@ -2812,18 +3700,92 @@ interface StatelessReadinessRequest {
|
|
|
2812
3700
|
* Do not edit manually.
|
|
2813
3701
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2814
3702
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2815
|
-
|
|
3703
|
+
|
|
3704
|
+
**Published:** 2026-08-18
|
|
3705
|
+
* OpenAPI spec version: 2026.16.1
|
|
3706
|
+
*/
|
|
3707
|
+
/**
|
|
3708
|
+
* Thin applicant projection returned within UW Submission V2
|
|
3709
|
+
*/
|
|
3710
|
+
interface UwSubmissionV2Applicant {
|
|
3711
|
+
/** Applicant record identifier */
|
|
3712
|
+
id?: string;
|
|
3713
|
+
/** Applicant email */
|
|
3714
|
+
email?: string;
|
|
3715
|
+
/** Unique FDR applicant ID */
|
|
3716
|
+
fdr_applicant_id?: string;
|
|
3717
|
+
/** Applicant first name */
|
|
3718
|
+
first_name?: string;
|
|
3719
|
+
/** Applicant last name */
|
|
3720
|
+
last_name?: string;
|
|
3721
|
+
/** Applicant email */
|
|
3722
|
+
client_email?: string;
|
|
3723
|
+
/** Applicant identity identifier */
|
|
3724
|
+
cerebro_id?: string;
|
|
3725
|
+
}
|
|
3726
|
+
|
|
3727
|
+
/**
|
|
3728
|
+
* Generated by orval v7.21.0 🍺
|
|
3729
|
+
* Do not edit manually.
|
|
3730
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
3731
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3732
|
+
|
|
3733
|
+
**Published:** 2026-08-18
|
|
3734
|
+
* OpenAPI spec version: 2026.16.1
|
|
2816
3735
|
*/
|
|
2817
3736
|
|
|
2818
3737
|
/**
|
|
2819
|
-
*
|
|
3738
|
+
* Thin application projection returned by UW Submission V2
|
|
3739
|
+
*/
|
|
3740
|
+
interface UwSubmissionV2Application {
|
|
3741
|
+
/** Application language */
|
|
3742
|
+
language?: string;
|
|
3743
|
+
applicant?: UwSubmissionV2Applicant;
|
|
3744
|
+
/** Application conditions */
|
|
3745
|
+
conditions?: LeadCondition[];
|
|
3746
|
+
/** Unique FDR applicant ID */
|
|
3747
|
+
fdr_applicant_id?: string;
|
|
3748
|
+
/** Current underwriting sub-status */
|
|
3749
|
+
sub_status?: string;
|
|
3750
|
+
/** Underlying application object type */
|
|
3751
|
+
object_type?: string;
|
|
3752
|
+
/** Current opportunity state */
|
|
3753
|
+
opportunity_state?: string;
|
|
3754
|
+
/** Applicant email associated with the application */
|
|
3755
|
+
client_email?: string;
|
|
3756
|
+
/** Applicant last name */
|
|
3757
|
+
last_name?: string;
|
|
3758
|
+
/** Law firm identifier */
|
|
3759
|
+
law_firm_id?: string;
|
|
3760
|
+
/** Current application stage */
|
|
3761
|
+
stage_name?: string;
|
|
3762
|
+
/** Application creation timestamp */
|
|
3763
|
+
created_date?: string;
|
|
3764
|
+
/** Applicant first name */
|
|
3765
|
+
first_name?: string;
|
|
3766
|
+
/** Applicant email */
|
|
3767
|
+
email?: string;
|
|
3768
|
+
}
|
|
3769
|
+
|
|
3770
|
+
/**
|
|
3771
|
+
* Generated by orval v7.21.0 🍺
|
|
3772
|
+
* Do not edit manually.
|
|
3773
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
3774
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3775
|
+
|
|
3776
|
+
**Published:** 2026-08-18
|
|
3777
|
+
* OpenAPI spec version: 2026.16.1
|
|
3778
|
+
*/
|
|
3779
|
+
|
|
3780
|
+
/**
|
|
3781
|
+
* UW Submission V2 response with a thin application projection, readiness checks, and two banking-disclosure outcome fields. Banking disclosure email is sent automatically on full UW approval (sub_status = 'UW Approved') and suppressed for conditional approvals.
|
|
2820
3782
|
*/
|
|
2821
3783
|
interface UwSubmissionV2Response {
|
|
2822
|
-
/**
|
|
3784
|
+
/** Response identifier */
|
|
2823
3785
|
id?: string;
|
|
2824
3786
|
/** Result message */
|
|
2825
3787
|
message?: string;
|
|
2826
|
-
application?:
|
|
3788
|
+
application?: UwSubmissionV2Application;
|
|
2827
3789
|
readiness?: LeadReadiness;
|
|
2828
3790
|
/** True when the banking disclosure email was sent successfully. False when the email was intentionally suppressed (e.g. conditional approval) or the downstream email service failed (failure is non-blocking). */
|
|
2829
3791
|
banking_disclosure_email_sent?: boolean;
|
|
@@ -2834,6 +3796,44 @@ interface UwSubmissionV2Response {
|
|
|
2834
3796
|
banking_disclosure_email_message?: string | null;
|
|
2835
3797
|
}
|
|
2836
3798
|
|
|
3799
|
+
/**
|
|
3800
|
+
* FDR's API speaks two vocabularies for the same value. You *send* a lowercase
|
|
3801
|
+
* schedule code (`bi-weekly`) to `selectProgram`; the lead *reports* a
|
|
3802
|
+
* capitalised label (`Bi-Weekly`) back on `application.draft_type`. Nothing in
|
|
3803
|
+
* the spec connects them, and the mismatch is silent — comparing what you sent
|
|
3804
|
+
* against what came back always looks like a failure.
|
|
3805
|
+
*
|
|
3806
|
+
* The labels below were confirmed against live STG by selecting each draft type
|
|
3807
|
+
* in turn. Through 2026.16.0 the spec documented `Monthly [Regular]` and
|
|
3808
|
+
* `Twice Monthly [Split]` for two of them and the API returned neither; 16.1
|
|
3809
|
+
* corrected the response enum, so the generated types now agree with the wire.
|
|
3810
|
+
* The two *vocabularies* remain — a corrected enum is not a unified one.
|
|
3811
|
+
*
|
|
3812
|
+
* Scope is narrow: `LeadApplication.draft_type` is the only label-valued site
|
|
3813
|
+
* in the whole spec. `PaymentSchedule` and `ProgramSelectionRequest` are both
|
|
3814
|
+
* already lowercase, and `LeadPatchRequest` has no `draft_type` at all, so
|
|
3815
|
+
* `selectProgram` is the only write path.
|
|
3816
|
+
*
|
|
3817
|
+
* These maps are annotated as `Record<>` over the generated enums on purpose:
|
|
3818
|
+
* if FDR ever adds a fourth draft type, codegen widens the enum and these fail
|
|
3819
|
+
* to compile until someone fills in the new key. The mapping keeps itself
|
|
3820
|
+
* honest without any bespoke assertion.
|
|
3821
|
+
*/
|
|
3822
|
+
/** Schedule code → the label the lead reports back. */
|
|
3823
|
+
declare const DRAFT_TYPE_LABEL: Record<ProgramSelectionRequestDraftType, LeadApplicationDraftType>;
|
|
3824
|
+
/** Lead-reported label → the schedule code `selectProgram` accepts. */
|
|
3825
|
+
declare const DRAFT_TYPE_CODE: Record<LeadApplicationDraftType, ProgramSelectionRequestDraftType>;
|
|
3826
|
+
/**
|
|
3827
|
+
* Read a lead's current draft type as a value you can hand straight back to
|
|
3828
|
+
* `selectProgram` — closing the round-trip FDR's two vocabularies leave open.
|
|
3829
|
+
*
|
|
3830
|
+
* Returns `undefined` when the lead has no selection yet, and also when the
|
|
3831
|
+
* label isn't one we know: the server can start returning a new picklist value
|
|
3832
|
+
* before we've regenerated against a newer spec, and guessing would be worse
|
|
3833
|
+
* than admitting we don't recognise it.
|
|
3834
|
+
*/
|
|
3835
|
+
declare const draftTypeOf: (application: LeadApplication | undefined | null) => ProgramSelectionRequestDraftType | undefined;
|
|
3836
|
+
|
|
2837
3837
|
/**
|
|
2838
3838
|
* ARPC SDK — a typed, agnostic client for FDR's ARPC DEX API (Achieve
|
|
2839
3839
|
* Resolution Partner Connect, Digital Enrollment Experience).
|
|
@@ -2878,6 +3878,7 @@ declare class ArpcSDK {
|
|
|
2878
3878
|
/** The full typed endpoint surface — one method per gateway operation. */
|
|
2879
3879
|
readonly api: {
|
|
2880
3880
|
createLeadSync: (createLeadRequest: CreateLeadRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<CreateLeadResponse>>;
|
|
3881
|
+
selectProgram: (programSelectionRequest: ProgramSelectionRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<LeadResponse>>;
|
|
2881
3882
|
checkApplicationReadiness: (statelessReadinessRequest: StatelessReadinessRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<ReadinessResponse>>;
|
|
2882
3883
|
createSpinwheelNetworkUser: (spinwheelNetworkUserRequest: SpinwheelNetworkUserRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<SpinwheelNetworkUserResponse>>;
|
|
2883
3884
|
updateApplicationBankDetails: (applicantId: string, bankUpdateRequest: BankUpdateRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<LeadResponse>>;
|
|
@@ -2887,7 +3888,7 @@ declare class ArpcSDK {
|
|
|
2887
3888
|
patchLead: (fdrApplicantId: string, leadPatchRequest: LeadPatchRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<LeadResponse>>;
|
|
2888
3889
|
getApplicationReadiness: (applicantId: string, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<ReadinessResponse>>;
|
|
2889
3890
|
generateDra: (applicantId: string, draRequest: DraRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<DraResponse>>;
|
|
2890
|
-
registerApplicantV2: (registerApplicantV2Request: RegisterApplicantV2Request, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<
|
|
3891
|
+
registerApplicantV2: (registerApplicantV2Request: RegisterApplicantV2Request, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<RegisterApplicantV2Response>>;
|
|
2891
3892
|
generateProgramV1: (programRequest: ProgramRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<LeadResponse>>;
|
|
2892
3893
|
checkEligibility: (eligibilityRequest: EligibilityRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<EligibilityResponse>>;
|
|
2893
3894
|
uwSubmissionV2: (fdrApplicantId: string, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<UwSubmissionV2Response>>;
|
|
@@ -2896,4 +3897,4 @@ declare class ArpcSDK {
|
|
|
2896
3897
|
constructor(config: ArpcConfig);
|
|
2897
3898
|
}
|
|
2898
3899
|
|
|
2899
|
-
export { type ARPCErrorResponse, ARPC_ENDPOINTS, type Address, type Applicant, type ApplicationSendEmailResponse, type ArpcAuth, type ArpcConfig, type ArpcEndpoint, type ArpcEnvironment, ArpcSDK, type ArpcUrls, type AuditInfo, type BankDetails, type BankDetailsInput, type BankUpdateRequest, type Check, CheckType, type CoApplicant, type Consents, type CreateLeadRequest, type CreateLeadResponse, type CreditPullConsent, type DebtAccount, type DraApplicant, type DraApplicantInput, DraApplicantInputSigningType, type DraRequest, type DraResponse, type EligibilityAddress, type EligibilityApplicant, type EligibilityApplication, type EligibilityDebtAccount, type EligibilityRequest, type EligibilityResponse, type ErrorDetails, type FieldValidationError, FieldValidationErrorReasonCode, type HttpResponse, type IneligibleReason, type LeadApplicant, LeadApplicantEmploymentStatus, type LeadApplicantInput, LeadApplicantPayFrequency, type LeadApplication, LeadApplicationCreditPullSource, LeadApplicationFdrOrCss, LeadApplicationFixedIncome, LeadApplicationOwnOrRent, type LeadCondition, LeadConditionActive, type LeadCreditor, type LeadDebtAccount, LeadDebtAccountOwnership, LeadDebtAccountResponsibility, type LeadDistribution, type LeadPatchRequest, type LeadReadiness, type LeadResponse, type LeadTransferRequest, type LeadTransferResponse, LeadTransferResponseResponse, type MailingAddress, type PatchAddress, type PatchApplicant, type PatchCoApplicant, type PatchCondition, type PatchDebtAccount, type PaymentOption, type ProgramRequest, type ProgramSummaryTaskRequest, type ProgramSummaryTaskResponse, type ReadinessCheck, ReadinessCheckType, type
|
|
3900
|
+
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 ReadinessResponse, type RegisterApplicantV2Address, type RegisterApplicantV2Request, type RegisterApplicantV2Response, type SpinwheelNetworkUserRequest, type SpinwheelNetworkUserResponse, type StatelessReadinessRequest, StatelessReadinessRequestGoalCategory, StatelessReadinessRequestHardshipCategory, type TokenCache, type Tracking, type UwSubmissionV2Applicant, type UwSubmissionV2Application, type UwSubmissionV2Response, draftTypeOf, isArpcEnvironment };
|