@borrowbetter/arpcsdk 0.6.0 → 0.8.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 +13 -6
- package/dist/index.d.mts +1467 -617
- package/dist/index.d.ts +1467 -617
- package/dist/index.js +79 -47
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +79 -47
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -88,10 +88,10 @@ interface ArpcConfig {
|
|
|
88
88
|
* Generated by orval v7.21.0 🍺
|
|
89
89
|
* Do not edit manually.
|
|
90
90
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
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. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
92
92
|
|
|
93
|
-
**Published:** 2026-
|
|
94
|
-
* OpenAPI spec version: 2026.
|
|
93
|
+
**Published:** 2026-10-30
|
|
94
|
+
* OpenAPI spec version: 2026.21.0
|
|
95
95
|
*/
|
|
96
96
|
/**
|
|
97
97
|
* Stable machine-readable reason for the violation. See ValidationReasonCode.
|
|
@@ -110,10 +110,10 @@ declare const FieldValidationErrorReasonCode: {
|
|
|
110
110
|
* Generated by orval v7.21.0 🍺
|
|
111
111
|
* Do not edit manually.
|
|
112
112
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
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. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
114
114
|
|
|
115
|
-
**Published:** 2026-
|
|
116
|
-
* OpenAPI spec version: 2026.
|
|
115
|
+
**Published:** 2026-10-30
|
|
116
|
+
* OpenAPI spec version: 2026.21.0
|
|
117
117
|
*/
|
|
118
118
|
|
|
119
119
|
/**
|
|
@@ -132,10 +132,10 @@ interface FieldValidationError {
|
|
|
132
132
|
* Generated by orval v7.21.0 🍺
|
|
133
133
|
* Do not edit manually.
|
|
134
134
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
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. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
136
136
|
|
|
137
|
-
**Published:** 2026-
|
|
138
|
-
* OpenAPI spec version: 2026.
|
|
137
|
+
**Published:** 2026-10-30
|
|
138
|
+
* OpenAPI spec version: 2026.21.0
|
|
139
139
|
*/
|
|
140
140
|
/**
|
|
141
141
|
* Check type identifier
|
|
@@ -152,10 +152,38 @@ declare const ReadinessCheckType: {
|
|
|
152
152
|
* Generated by orval v7.21.0 🍺
|
|
153
153
|
* Do not edit manually.
|
|
154
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.
|
|
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. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
156
156
|
|
|
157
|
-
**Published:** 2026-
|
|
158
|
-
* OpenAPI spec version: 2026.
|
|
157
|
+
**Published:** 2026-10-30
|
|
158
|
+
* OpenAPI spec version: 2026.21.0
|
|
159
|
+
*/
|
|
160
|
+
/**
|
|
161
|
+
* Validation error messages if the check failed
|
|
162
|
+
*/
|
|
163
|
+
type ReadinessCheckErrors = string[] | null;
|
|
164
|
+
|
|
165
|
+
/**
|
|
166
|
+
* Generated by orval v7.21.0 🍺
|
|
167
|
+
* Do not edit manually.
|
|
168
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
169
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
170
|
+
|
|
171
|
+
**Published:** 2026-10-30
|
|
172
|
+
* OpenAPI spec version: 2026.21.0
|
|
173
|
+
*/
|
|
174
|
+
/**
|
|
175
|
+
* Dotted JSON path of the input field that caused the failure (snake_case). Omitted when the failure is not tied to a specific field.
|
|
176
|
+
*/
|
|
177
|
+
type ReadinessErrorDetailField = string | null;
|
|
178
|
+
|
|
179
|
+
/**
|
|
180
|
+
* Generated by orval v7.21.0 🍺
|
|
181
|
+
* Do not edit manually.
|
|
182
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
183
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
184
|
+
|
|
185
|
+
**Published:** 2026-10-30
|
|
186
|
+
* OpenAPI spec version: 2026.21.0
|
|
159
187
|
*/
|
|
160
188
|
/**
|
|
161
189
|
* Stable machine-readable code you can safely branch on.
|
|
@@ -179,36 +207,47 @@ declare const ReadinessErrorDetailReasonCode: {
|
|
|
179
207
|
* Generated by orval v7.21.0 🍺
|
|
180
208
|
* Do not edit manually.
|
|
181
209
|
* 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.
|
|
210
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
183
211
|
|
|
184
|
-
**Published:** 2026-
|
|
185
|
-
* OpenAPI spec version: 2026.
|
|
212
|
+
**Published:** 2026-10-30
|
|
213
|
+
* OpenAPI spec version: 2026.21.0
|
|
186
214
|
*/
|
|
187
215
|
|
|
188
216
|
/**
|
|
189
217
|
* Structured failure entry within a readiness check
|
|
190
|
-
* @nullable
|
|
191
218
|
*/
|
|
192
|
-
|
|
193
|
-
/**
|
|
194
|
-
|
|
195
|
-
* @nullable
|
|
196
|
-
*/
|
|
197
|
-
field?: string | null;
|
|
219
|
+
interface ReadinessErrorDetail {
|
|
220
|
+
/** Dotted JSON path of the input field that caused the failure (snake_case). Omitted when the failure is not tied to a specific field. */
|
|
221
|
+
field?: ReadinessErrorDetailField;
|
|
198
222
|
/** Stable machine-readable code you can safely branch on. */
|
|
199
223
|
reason_code?: ReadinessErrorDetailReasonCode;
|
|
200
224
|
/** Human-readable explanation — same text as in errors[]. May be reworded over time; do not match on this value. */
|
|
201
225
|
message?: string;
|
|
202
|
-
}
|
|
226
|
+
}
|
|
227
|
+
|
|
228
|
+
/**
|
|
229
|
+
* Generated by orval v7.21.0 🍺
|
|
230
|
+
* Do not edit manually.
|
|
231
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
232
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
233
|
+
|
|
234
|
+
**Published:** 2026-10-30
|
|
235
|
+
* OpenAPI spec version: 2026.21.0
|
|
236
|
+
*/
|
|
237
|
+
|
|
238
|
+
/**
|
|
239
|
+
* 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.
|
|
240
|
+
*/
|
|
241
|
+
type ReadinessCheckErrorDetails = ReadinessErrorDetail[] | null;
|
|
203
242
|
|
|
204
243
|
/**
|
|
205
244
|
* Generated by orval v7.21.0 🍺
|
|
206
245
|
* Do not edit manually.
|
|
207
246
|
* 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.
|
|
247
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
209
248
|
|
|
210
|
-
**Published:** 2026-
|
|
211
|
-
* OpenAPI spec version: 2026.
|
|
249
|
+
**Published:** 2026-10-30
|
|
250
|
+
* OpenAPI spec version: 2026.21.0
|
|
212
251
|
*/
|
|
213
252
|
|
|
214
253
|
/**
|
|
@@ -219,54 +258,75 @@ interface ReadinessCheck {
|
|
|
219
258
|
type?: ReadinessCheckType;
|
|
220
259
|
/** Whether this check passed */
|
|
221
260
|
verified?: boolean;
|
|
222
|
-
/**
|
|
223
|
-
|
|
224
|
-
|
|
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;
|
|
261
|
+
/** Validation error messages if the check failed */
|
|
262
|
+
errors?: ReadinessCheckErrors;
|
|
263
|
+
/** 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. */
|
|
264
|
+
error_details?: ReadinessCheckErrorDetails;
|
|
232
265
|
}
|
|
233
266
|
|
|
234
267
|
/**
|
|
235
268
|
* Generated by orval v7.21.0 🍺
|
|
236
269
|
* Do not edit manually.
|
|
237
270
|
* 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.
|
|
271
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
239
272
|
|
|
240
|
-
**Published:** 2026-
|
|
241
|
-
* OpenAPI spec version: 2026.
|
|
273
|
+
**Published:** 2026-10-30
|
|
274
|
+
* OpenAPI spec version: 2026.21.0
|
|
275
|
+
*/
|
|
276
|
+
/**
|
|
277
|
+
* Summary message for the readiness failure
|
|
278
|
+
*/
|
|
279
|
+
type ErrorDetailsMessage = string | null;
|
|
280
|
+
|
|
281
|
+
/**
|
|
282
|
+
* Generated by orval v7.21.0 🍺
|
|
283
|
+
* Do not edit manually.
|
|
284
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
285
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
286
|
+
|
|
287
|
+
**Published:** 2026-10-30
|
|
288
|
+
* OpenAPI spec version: 2026.21.0
|
|
242
289
|
*/
|
|
243
290
|
|
|
244
291
|
/**
|
|
245
292
|
* Readiness check breakdown
|
|
246
|
-
* @nullable
|
|
247
293
|
*/
|
|
248
|
-
|
|
294
|
+
interface ErrorDetails {
|
|
249
295
|
/** Per-gate check results */
|
|
250
296
|
checks?: ReadinessCheck[];
|
|
251
|
-
/**
|
|
252
|
-
|
|
253
|
-
* @nullable
|
|
254
|
-
*/
|
|
255
|
-
message?: string | null;
|
|
297
|
+
/** Summary message for the readiness failure */
|
|
298
|
+
message?: ErrorDetailsMessage;
|
|
256
299
|
/** Whether a program refresh is required before re-submission */
|
|
257
300
|
is_program_refresh_required?: boolean;
|
|
258
301
|
/** Whether the application is currently UW-approved */
|
|
259
302
|
is_uw_approved?: boolean;
|
|
260
|
-
}
|
|
303
|
+
}
|
|
261
304
|
|
|
262
305
|
/**
|
|
263
306
|
* Generated by orval v7.21.0 🍺
|
|
264
307
|
* Do not edit manually.
|
|
265
308
|
* 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.
|
|
309
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
310
|
+
|
|
311
|
+
**Published:** 2026-10-30
|
|
312
|
+
* OpenAPI spec version: 2026.21.0
|
|
313
|
+
*/
|
|
314
|
+
|
|
315
|
+
/**
|
|
316
|
+
* Optional readiness-gate breakdown. Present for readiness failures such as ER40301, ER40303, ER40304, and ER40305.
|
|
267
317
|
|
|
268
|
-
|
|
269
|
-
|
|
318
|
+
⚠️ Patched locally by `openapi/repairs.ts` — this differs from FDR's published spec.
|
|
319
|
+
*/
|
|
320
|
+
type ARPCErrorResponseErrorDetails = ErrorDetails | null;
|
|
321
|
+
|
|
322
|
+
/**
|
|
323
|
+
* Generated by orval v7.21.0 🍺
|
|
324
|
+
* Do not edit manually.
|
|
325
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
326
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
327
|
+
|
|
328
|
+
**Published:** 2026-10-30
|
|
329
|
+
* OpenAPI spec version: 2026.21.0
|
|
270
330
|
*/
|
|
271
331
|
|
|
272
332
|
/**
|
|
@@ -281,7 +341,10 @@ interface ARPCErrorResponse {
|
|
|
281
341
|
error?: string;
|
|
282
342
|
/** Field-level violations. Present only for field-validation failures (e.g. ER40001, ER00400); absent for upstream, auth, or internal errors. */
|
|
283
343
|
errors?: FieldValidationError[];
|
|
284
|
-
|
|
344
|
+
/** Optional readiness-gate breakdown. Present for readiness failures such as ER40301, ER40303, ER40304, and ER40305.
|
|
345
|
+
|
|
346
|
+
⚠️ Patched locally by `openapi/repairs.ts` — this differs from FDR's published spec. */
|
|
347
|
+
error_details?: ARPCErrorResponseErrorDetails;
|
|
285
348
|
/** Free-text reason for non-field-validation failures (upstream rejection, auth failure, internal error). Absent when 'errors[]' is populated. */
|
|
286
349
|
message?: string;
|
|
287
350
|
/** ISO-8601 UTC timestamp of when the error occurred */
|
|
@@ -294,10 +357,10 @@ interface ARPCErrorResponse {
|
|
|
294
357
|
* Generated by orval v7.21.0 🍺
|
|
295
358
|
* Do not edit manually.
|
|
296
359
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
360
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
298
361
|
|
|
299
|
-
**Published:** 2026-
|
|
300
|
-
* OpenAPI spec version: 2026.
|
|
362
|
+
**Published:** 2026-10-30
|
|
363
|
+
* OpenAPI spec version: 2026.21.0
|
|
301
364
|
*/
|
|
302
365
|
/**
|
|
303
366
|
* Street address
|
|
@@ -319,10 +382,159 @@ interface Address {
|
|
|
319
382
|
* Generated by orval v7.21.0 🍺
|
|
320
383
|
* Do not edit manually.
|
|
321
384
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
385
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
323
386
|
|
|
324
|
-
**Published:** 2026-
|
|
325
|
-
* OpenAPI spec version: 2026.
|
|
387
|
+
**Published:** 2026-10-30
|
|
388
|
+
* OpenAPI spec version: 2026.21.0
|
|
389
|
+
*/
|
|
390
|
+
/**
|
|
391
|
+
* Error context for agreement lifecycle failures
|
|
392
|
+
|
|
393
|
+
⚠️ Added locally by `openapi/repairs.ts` — FDR serves this, but their published spec doesn't document it.
|
|
394
|
+
*/
|
|
395
|
+
interface AgreementErrorDetails {
|
|
396
|
+
envelope_id?: string;
|
|
397
|
+
}
|
|
398
|
+
|
|
399
|
+
/**
|
|
400
|
+
* Generated by orval v7.21.0 🍺
|
|
401
|
+
* Do not edit manually.
|
|
402
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
403
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
404
|
+
|
|
405
|
+
**Published:** 2026-10-30
|
|
406
|
+
* OpenAPI spec version: 2026.21.0
|
|
407
|
+
*/
|
|
408
|
+
|
|
409
|
+
/**
|
|
410
|
+
* ARPCErrorResponse whose `error_details` carries the envelope rather than readiness checks. ER40501 covers both an unknown envelope and one already voided, completed or declined — terminal, don't retry.
|
|
411
|
+
|
|
412
|
+
⚠️ Added locally by `openapi/repairs.ts` — FDR serves this, but their published spec doesn't document it.
|
|
413
|
+
*/
|
|
414
|
+
interface AgreementErrorResponse {
|
|
415
|
+
/** HTTP status code */
|
|
416
|
+
status?: number;
|
|
417
|
+
/** ARPC error classification code */
|
|
418
|
+
error_code?: string;
|
|
419
|
+
/** Human-readable error sentence */
|
|
420
|
+
error?: string;
|
|
421
|
+
/** Field-level violations. Present only for field-validation failures (e.g. ER40001, ER00400); absent for upstream, auth, or internal errors. */
|
|
422
|
+
errors?: FieldValidationError[];
|
|
423
|
+
error_details?: AgreementErrorDetails;
|
|
424
|
+
/** Free-text reason for non-field-validation failures (upstream rejection, auth failure, internal error). Absent when 'errors[]' is populated. */
|
|
425
|
+
message?: string;
|
|
426
|
+
/** ISO-8601 UTC timestamp of when the error occurred */
|
|
427
|
+
timestamp?: string;
|
|
428
|
+
/** Correlation ID for distributed tracing across services */
|
|
429
|
+
x_correlation_id?: string;
|
|
430
|
+
}
|
|
431
|
+
|
|
432
|
+
/**
|
|
433
|
+
* Generated by orval v7.21.0 🍺
|
|
434
|
+
* Do not edit manually.
|
|
435
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
436
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
437
|
+
|
|
438
|
+
**Published:** 2026-10-30
|
|
439
|
+
* OpenAPI spec version: 2026.21.0
|
|
440
|
+
*/
|
|
441
|
+
/**
|
|
442
|
+
* `url` returns a fresh embedded signing URL; `email` triggers DocuSign's email flow and returns no URL.
|
|
443
|
+
*/
|
|
444
|
+
type AgreementResendApplicantSigningType = typeof AgreementResendApplicantSigningType[keyof typeof AgreementResendApplicantSigningType];
|
|
445
|
+
declare const AgreementResendApplicantSigningType: {
|
|
446
|
+
readonly url: "url";
|
|
447
|
+
readonly email: "email";
|
|
448
|
+
};
|
|
449
|
+
|
|
450
|
+
/**
|
|
451
|
+
* Generated by orval v7.21.0 🍺
|
|
452
|
+
* Do not edit manually.
|
|
453
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
454
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
455
|
+
|
|
456
|
+
**Published:** 2026-10-30
|
|
457
|
+
* OpenAPI spec version: 2026.21.0
|
|
458
|
+
*/
|
|
459
|
+
|
|
460
|
+
/**
|
|
461
|
+
* Applicant resend preferences
|
|
462
|
+
|
|
463
|
+
⚠️ Added locally by `openapi/repairs.ts` — FDR serves this, but their published spec doesn't document it.
|
|
464
|
+
*/
|
|
465
|
+
interface AgreementResendApplicant {
|
|
466
|
+
/** `url` returns a fresh embedded signing URL; `email` triggers DocuSign's email flow and returns no URL. */
|
|
467
|
+
signing_type: AgreementResendApplicantSigningType;
|
|
468
|
+
}
|
|
469
|
+
|
|
470
|
+
/**
|
|
471
|
+
* Generated by orval v7.21.0 🍺
|
|
472
|
+
* Do not edit manually.
|
|
473
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
474
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
475
|
+
|
|
476
|
+
**Published:** 2026-10-30
|
|
477
|
+
* OpenAPI spec version: 2026.21.0
|
|
478
|
+
*/
|
|
479
|
+
|
|
480
|
+
/**
|
|
481
|
+
* Request body to resend an existing DRA envelope
|
|
482
|
+
|
|
483
|
+
⚠️ Added locally by `openapi/repairs.ts` — FDR serves this, but their published spec doesn't document it.
|
|
484
|
+
*/
|
|
485
|
+
interface AgreementResendRequest {
|
|
486
|
+
applicant: AgreementResendApplicant;
|
|
487
|
+
}
|
|
488
|
+
|
|
489
|
+
/**
|
|
490
|
+
* Generated by orval v7.21.0 🍺
|
|
491
|
+
* Do not edit manually.
|
|
492
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
493
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
494
|
+
|
|
495
|
+
**Published:** 2026-10-30
|
|
496
|
+
* OpenAPI spec version: 2026.21.0
|
|
497
|
+
*/
|
|
498
|
+
/**
|
|
499
|
+
* Request body to void a DRA envelope
|
|
500
|
+
|
|
501
|
+
⚠️ Added locally by `openapi/repairs.ts` — FDR serves this, but their published spec doesn't document it.
|
|
502
|
+
*/
|
|
503
|
+
interface AgreementVoidRequest {
|
|
504
|
+
/** Business reason for the void */
|
|
505
|
+
voiding_reason: string;
|
|
506
|
+
}
|
|
507
|
+
|
|
508
|
+
/**
|
|
509
|
+
* Generated by orval v7.21.0 🍺
|
|
510
|
+
* Do not edit manually.
|
|
511
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
512
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
513
|
+
|
|
514
|
+
**Published:** 2026-10-30
|
|
515
|
+
* OpenAPI spec version: 2026.21.0
|
|
516
|
+
*/
|
|
517
|
+
/**
|
|
518
|
+
* Void confirmation. Note the camelCase keys, unlike the rest of the API.
|
|
519
|
+
|
|
520
|
+
⚠️ Added locally by `openapi/repairs.ts` — FDR serves this, but their published spec doesn't document it.
|
|
521
|
+
*/
|
|
522
|
+
interface AgreementVoidResponse {
|
|
523
|
+
status?: string;
|
|
524
|
+
envelopeId?: string;
|
|
525
|
+
/** Zone-less local timestamp, e.g. `2026-09-03T19:59:37.272043773` */
|
|
526
|
+
statusDateTime?: string;
|
|
527
|
+
xCorrelationId?: string;
|
|
528
|
+
}
|
|
529
|
+
|
|
530
|
+
/**
|
|
531
|
+
* Generated by orval v7.21.0 🍺
|
|
532
|
+
* Do not edit manually.
|
|
533
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
534
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
535
|
+
|
|
536
|
+
**Published:** 2026-10-30
|
|
537
|
+
* OpenAPI spec version: 2026.21.0
|
|
326
538
|
*/
|
|
327
539
|
/**
|
|
328
540
|
* Address used by v2. ZIP is exposed as zip_code on the public request.
|
|
@@ -344,10 +556,10 @@ interface RegisterApplicantV2Address {
|
|
|
344
556
|
* Generated by orval v7.21.0 🍺
|
|
345
557
|
* Do not edit manually.
|
|
346
558
|
* ARPC — Achieve Resolution Partner Connect API
|
|
347
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
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. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
348
560
|
|
|
349
|
-
**Published:** 2026-
|
|
350
|
-
* OpenAPI spec version: 2026.
|
|
561
|
+
**Published:** 2026-10-30
|
|
562
|
+
* OpenAPI spec version: 2026.21.0
|
|
351
563
|
*/
|
|
352
564
|
|
|
353
565
|
/**
|
|
@@ -379,7 +591,9 @@ interface Applicant {
|
|
|
379
591
|
date_of_birth: string;
|
|
380
592
|
/** Spinwheel network user token for credit-pull linkage */
|
|
381
593
|
network_token: string;
|
|
594
|
+
/** Applicant's physical / residential address */
|
|
382
595
|
physical_address: RegisterApplicantV2Address;
|
|
596
|
+
/** Applicant's mailing address (all fields optional) */
|
|
383
597
|
mailing_address?: RegisterApplicantV2Address;
|
|
384
598
|
}
|
|
385
599
|
|
|
@@ -387,10 +601,10 @@ interface Applicant {
|
|
|
387
601
|
* Generated by orval v7.21.0 🍺
|
|
388
602
|
* Do not edit manually.
|
|
389
603
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
604
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
391
605
|
|
|
392
|
-
**Published:** 2026-
|
|
393
|
-
* OpenAPI spec version: 2026.
|
|
606
|
+
**Published:** 2026-10-30
|
|
607
|
+
* OpenAPI spec version: 2026.21.0
|
|
394
608
|
*/
|
|
395
609
|
interface ApplicationSendEmailResponse {
|
|
396
610
|
status?: string;
|
|
@@ -403,10 +617,10 @@ interface ApplicationSendEmailResponse {
|
|
|
403
617
|
* Generated by orval v7.21.0 🍺
|
|
404
618
|
* Do not edit manually.
|
|
405
619
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
620
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
407
621
|
|
|
408
|
-
**Published:** 2026-
|
|
409
|
-
* OpenAPI spec version: 2026.
|
|
622
|
+
**Published:** 2026-10-30
|
|
623
|
+
* OpenAPI spec version: 2026.21.0
|
|
410
624
|
*/
|
|
411
625
|
/**
|
|
412
626
|
* Audit metadata
|
|
@@ -420,10 +634,10 @@ interface AuditInfo {
|
|
|
420
634
|
* Generated by orval v7.21.0 🍺
|
|
421
635
|
* Do not edit manually.
|
|
422
636
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
637
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
424
638
|
|
|
425
|
-
**Published:** 2026-
|
|
426
|
-
* OpenAPI spec version: 2026.
|
|
639
|
+
**Published:** 2026-10-30
|
|
640
|
+
* OpenAPI spec version: 2026.21.0
|
|
427
641
|
*/
|
|
428
642
|
/**
|
|
429
643
|
* Account type
|
|
@@ -438,10 +652,10 @@ declare const BankDetailsAccountType: {
|
|
|
438
652
|
* Generated by orval v7.21.0 🍺
|
|
439
653
|
* Do not edit manually.
|
|
440
654
|
* 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.
|
|
655
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
442
656
|
|
|
443
|
-
**Published:** 2026-
|
|
444
|
-
* OpenAPI spec version: 2026.
|
|
657
|
+
**Published:** 2026-10-30
|
|
658
|
+
* OpenAPI spec version: 2026.21.0
|
|
445
659
|
*/
|
|
446
660
|
/**
|
|
447
661
|
* Account sub-type
|
|
@@ -456,17 +670,16 @@ declare const BankDetailsAccountSubtype: {
|
|
|
456
670
|
* Generated by orval v7.21.0 🍺
|
|
457
671
|
* Do not edit manually.
|
|
458
672
|
* 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.
|
|
673
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
460
674
|
|
|
461
|
-
**Published:** 2026-
|
|
462
|
-
* OpenAPI spec version: 2026.
|
|
675
|
+
**Published:** 2026-10-30
|
|
676
|
+
* OpenAPI spec version: 2026.21.0
|
|
463
677
|
*/
|
|
464
678
|
|
|
465
679
|
/**
|
|
466
680
|
* Bank account details used for programme drafts
|
|
467
|
-
* @nullable
|
|
468
681
|
*/
|
|
469
|
-
|
|
682
|
+
interface BankDetails {
|
|
470
683
|
/** Bank name */
|
|
471
684
|
name?: string;
|
|
472
685
|
/** Account type */
|
|
@@ -483,6 +696,7 @@ type BankDetails = {
|
|
|
483
696
|
validation_message?: string;
|
|
484
697
|
/** Exact name on the bank account */
|
|
485
698
|
check_exact_name?: string;
|
|
699
|
+
/** Exact address on the bank account */
|
|
486
700
|
check_exact_address?: Address;
|
|
487
701
|
/** Whether a pre-draft has been taken */
|
|
488
702
|
pre_draft?: boolean;
|
|
@@ -492,16 +706,16 @@ type BankDetails = {
|
|
|
492
706
|
mother_maiden_name?: string;
|
|
493
707
|
/** Government-issued ID number for account verification */
|
|
494
708
|
government_issued_id?: string;
|
|
495
|
-
}
|
|
709
|
+
}
|
|
496
710
|
|
|
497
711
|
/**
|
|
498
712
|
* Generated by orval v7.21.0 🍺
|
|
499
713
|
* Do not edit manually.
|
|
500
714
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
715
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
502
716
|
|
|
503
|
-
**Published:** 2026-
|
|
504
|
-
* OpenAPI spec version: 2026.
|
|
717
|
+
**Published:** 2026-10-30
|
|
718
|
+
* OpenAPI spec version: 2026.21.0
|
|
505
719
|
*/
|
|
506
720
|
/**
|
|
507
721
|
* Bank account input fields
|
|
@@ -517,10 +731,10 @@ interface BankDetailsInput {
|
|
|
517
731
|
* Generated by orval v7.21.0 🍺
|
|
518
732
|
* Do not edit manually.
|
|
519
733
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
734
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
521
735
|
|
|
522
|
-
**Published:** 2026-
|
|
523
|
-
* OpenAPI spec version: 2026.
|
|
736
|
+
**Published:** 2026-10-30
|
|
737
|
+
* OpenAPI spec version: 2026.21.0
|
|
524
738
|
*/
|
|
525
739
|
|
|
526
740
|
/**
|
|
@@ -531,6 +745,7 @@ interface BankUpdateRequest {
|
|
|
531
745
|
banking_disclosure_validation: boolean;
|
|
532
746
|
/** Bank verification code (micro-deposit or other challenge code) */
|
|
533
747
|
verification_code?: string;
|
|
748
|
+
/** Bank account details to associate with this application */
|
|
534
749
|
bank_details: BankDetailsInput;
|
|
535
750
|
}
|
|
536
751
|
|
|
@@ -538,10 +753,10 @@ interface BankUpdateRequest {
|
|
|
538
753
|
* Generated by orval v7.21.0 🍺
|
|
539
754
|
* Do not edit manually.
|
|
540
755
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
756
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
542
757
|
|
|
543
|
-
**Published:** 2026-
|
|
544
|
-
* OpenAPI spec version: 2026.
|
|
758
|
+
**Published:** 2026-10-30
|
|
759
|
+
* OpenAPI spec version: 2026.21.0
|
|
545
760
|
*/
|
|
546
761
|
/**
|
|
547
762
|
* Check type identifier
|
|
@@ -556,10 +771,39 @@ declare const CheckType: {
|
|
|
556
771
|
* Generated by orval v7.21.0 🍺
|
|
557
772
|
* Do not edit manually.
|
|
558
773
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
774
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
775
|
+
|
|
776
|
+
**Published:** 2026-10-30
|
|
777
|
+
* OpenAPI spec version: 2026.21.0
|
|
778
|
+
*/
|
|
779
|
+
/**
|
|
780
|
+
* Validation errors that caused this check to fail, if any
|
|
781
|
+
*/
|
|
782
|
+
type CheckErrors = string[] | null;
|
|
783
|
+
|
|
784
|
+
/**
|
|
785
|
+
* Generated by orval v7.21.0 🍺
|
|
786
|
+
* Do not edit manually.
|
|
787
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
788
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
560
789
|
|
|
561
|
-
**Published:** 2026-
|
|
562
|
-
* OpenAPI spec version: 2026.
|
|
790
|
+
**Published:** 2026-10-30
|
|
791
|
+
* OpenAPI spec version: 2026.21.0
|
|
792
|
+
*/
|
|
793
|
+
|
|
794
|
+
/**
|
|
795
|
+
* Structured validation details for this readiness check
|
|
796
|
+
*/
|
|
797
|
+
type CheckErrorDetails = ReadinessErrorDetail[] | null;
|
|
798
|
+
|
|
799
|
+
/**
|
|
800
|
+
* Generated by orval v7.21.0 🍺
|
|
801
|
+
* Do not edit manually.
|
|
802
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
803
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
804
|
+
|
|
805
|
+
**Published:** 2026-10-30
|
|
806
|
+
* OpenAPI spec version: 2026.21.0
|
|
563
807
|
*/
|
|
564
808
|
|
|
565
809
|
/**
|
|
@@ -570,26 +814,20 @@ interface Check {
|
|
|
570
814
|
type?: CheckType;
|
|
571
815
|
/** Whether this check passed */
|
|
572
816
|
verified?: boolean;
|
|
573
|
-
/**
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
errors?: (string | null)[] | null;
|
|
578
|
-
/**
|
|
579
|
-
* Structured validation details for this readiness check
|
|
580
|
-
* @nullable
|
|
581
|
-
*/
|
|
582
|
-
error_details?: ReadinessErrorDetail[] | null;
|
|
817
|
+
/** Validation errors that caused this check to fail, if any */
|
|
818
|
+
errors?: CheckErrors;
|
|
819
|
+
/** Structured validation details for this readiness check */
|
|
820
|
+
error_details?: CheckErrorDetails;
|
|
583
821
|
}
|
|
584
822
|
|
|
585
823
|
/**
|
|
586
824
|
* Generated by orval v7.21.0 🍺
|
|
587
825
|
* Do not edit manually.
|
|
588
826
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
827
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
590
828
|
|
|
591
|
-
**Published:** 2026-
|
|
592
|
-
* OpenAPI spec version: 2026.
|
|
829
|
+
**Published:** 2026-10-30
|
|
830
|
+
* OpenAPI spec version: 2026.21.0
|
|
593
831
|
*/
|
|
594
832
|
|
|
595
833
|
/**
|
|
@@ -610,7 +848,9 @@ interface CoApplicant {
|
|
|
610
848
|
email?: string;
|
|
611
849
|
/** Date of birth (YYYY-MM-DD) */
|
|
612
850
|
date_of_birth?: string;
|
|
851
|
+
/** Current residential address */
|
|
613
852
|
current_address?: Address;
|
|
853
|
+
/** Mailing address (if different from current) */
|
|
614
854
|
mailing_address?: Address;
|
|
615
855
|
/** Primary monthly income */
|
|
616
856
|
monthly_income?: number;
|
|
@@ -656,10 +896,10 @@ interface CoApplicant {
|
|
|
656
896
|
* Generated by orval v7.21.0 🍺
|
|
657
897
|
* Do not edit manually.
|
|
658
898
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
899
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
660
900
|
|
|
661
|
-
**Published:** 2026-
|
|
662
|
-
* OpenAPI spec version: 2026.
|
|
901
|
+
**Published:** 2026-10-30
|
|
902
|
+
* OpenAPI spec version: 2026.21.0
|
|
663
903
|
*/
|
|
664
904
|
/**
|
|
665
905
|
* Required consent strings for regulatory and platform compliance
|
|
@@ -681,10 +921,10 @@ interface Consents {
|
|
|
681
921
|
* Generated by orval v7.21.0 🍺
|
|
682
922
|
* Do not edit manually.
|
|
683
923
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
924
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
685
925
|
|
|
686
|
-
**Published:** 2026-
|
|
687
|
-
* OpenAPI spec version: 2026.
|
|
926
|
+
**Published:** 2026-10-30
|
|
927
|
+
* OpenAPI spec version: 2026.21.0
|
|
688
928
|
*/
|
|
689
929
|
/**
|
|
690
930
|
* Lead distribution routing configuration
|
|
@@ -700,10 +940,10 @@ interface LeadDistribution {
|
|
|
700
940
|
* Generated by orval v7.21.0 🍺
|
|
701
941
|
* Do not edit manually.
|
|
702
942
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
943
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
704
944
|
|
|
705
|
-
**Published:** 2026-
|
|
706
|
-
* OpenAPI spec version: 2026.
|
|
945
|
+
**Published:** 2026-10-30
|
|
946
|
+
* OpenAPI spec version: 2026.21.0
|
|
707
947
|
*/
|
|
708
948
|
/**
|
|
709
949
|
* Primary hardship category
|
|
@@ -722,10 +962,10 @@ declare const CreateLeadRequestHardshipCategory: {
|
|
|
722
962
|
* Generated by orval v7.21.0 🍺
|
|
723
963
|
* Do not edit manually.
|
|
724
964
|
* 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.
|
|
965
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
726
966
|
|
|
727
|
-
**Published:** 2026-
|
|
728
|
-
* OpenAPI spec version: 2026.
|
|
967
|
+
**Published:** 2026-10-30
|
|
968
|
+
* OpenAPI spec version: 2026.21.0
|
|
729
969
|
*/
|
|
730
970
|
/**
|
|
731
971
|
* Primary goal category
|
|
@@ -742,10 +982,10 @@ declare const CreateLeadRequestGoalCategory: {
|
|
|
742
982
|
* Generated by orval v7.21.0 🍺
|
|
743
983
|
* Do not edit manually.
|
|
744
984
|
* 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.
|
|
985
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
746
986
|
|
|
747
|
-
**Published:** 2026-
|
|
748
|
-
* OpenAPI spec version: 2026.
|
|
987
|
+
**Published:** 2026-10-30
|
|
988
|
+
* OpenAPI spec version: 2026.21.0
|
|
749
989
|
*/
|
|
750
990
|
|
|
751
991
|
/**
|
|
@@ -778,7 +1018,9 @@ interface LeadApplicantInput {
|
|
|
778
1018
|
email?: string;
|
|
779
1019
|
/** Date of birth (YYYY-MM-DD) */
|
|
780
1020
|
date_of_birth?: string;
|
|
1021
|
+
/** Current residential address */
|
|
781
1022
|
current_address?: Address;
|
|
1023
|
+
/** Mailing address (if different from current) */
|
|
782
1024
|
mailing_address?: Address;
|
|
783
1025
|
/** Primary monthly income */
|
|
784
1026
|
monthly_income?: number;
|
|
@@ -822,10 +1064,10 @@ interface LeadApplicantInput {
|
|
|
822
1064
|
* Generated by orval v7.21.0 🍺
|
|
823
1065
|
* Do not edit manually.
|
|
824
1066
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
1067
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
826
1068
|
|
|
827
|
-
**Published:** 2026-
|
|
828
|
-
* OpenAPI spec version: 2026.
|
|
1069
|
+
**Published:** 2026-10-30
|
|
1070
|
+
* OpenAPI spec version: 2026.21.0
|
|
829
1071
|
*/
|
|
830
1072
|
/**
|
|
831
1073
|
* Whether the condition is currently active
|
|
@@ -840,10 +1082,10 @@ declare const LeadConditionActive: {
|
|
|
840
1082
|
* Generated by orval v7.21.0 🍺
|
|
841
1083
|
* Do not edit manually.
|
|
842
1084
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
1085
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
844
1086
|
|
|
845
|
-
**Published:** 2026-
|
|
846
|
-
* OpenAPI spec version: 2026.
|
|
1087
|
+
**Published:** 2026-10-30
|
|
1088
|
+
* OpenAPI spec version: 2026.21.0
|
|
847
1089
|
*/
|
|
848
1090
|
/**
|
|
849
1091
|
* Condition type. soft-condition types omit the verified field in the response.
|
|
@@ -860,17 +1102,44 @@ declare const LeadConditionType: {
|
|
|
860
1102
|
* Generated by orval v7.21.0 🍺
|
|
861
1103
|
* Do not edit manually.
|
|
862
1104
|
* 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.
|
|
1105
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1106
|
+
|
|
1107
|
+
**Published:** 2026-10-30
|
|
1108
|
+
* OpenAPI spec version: 2026.21.0
|
|
1109
|
+
*/
|
|
1110
|
+
/**
|
|
1111
|
+
* Whether the condition has been verified by underwriting. Absent for soft-condition type.
|
|
1112
|
+
*/
|
|
1113
|
+
type LeadConditionVerified = boolean | null;
|
|
1114
|
+
|
|
1115
|
+
/**
|
|
1116
|
+
* Generated by orval v7.21.0 🍺
|
|
1117
|
+
* Do not edit manually.
|
|
1118
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1119
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1120
|
+
|
|
1121
|
+
**Published:** 2026-10-30
|
|
1122
|
+
* OpenAPI spec version: 2026.21.0
|
|
1123
|
+
*/
|
|
1124
|
+
/**
|
|
1125
|
+
* Whether the condition was verified by a debt consultant
|
|
1126
|
+
*/
|
|
1127
|
+
type LeadConditionVerifiedByDebtConsultant = boolean | null;
|
|
1128
|
+
|
|
1129
|
+
/**
|
|
1130
|
+
* Generated by orval v7.21.0 🍺
|
|
1131
|
+
* Do not edit manually.
|
|
1132
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1133
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
864
1134
|
|
|
865
|
-
**Published:** 2026-
|
|
866
|
-
* OpenAPI spec version: 2026.
|
|
1135
|
+
**Published:** 2026-10-30
|
|
1136
|
+
* OpenAPI spec version: 2026.21.0
|
|
867
1137
|
*/
|
|
868
1138
|
|
|
869
1139
|
/**
|
|
870
1140
|
* Underwriting or program condition
|
|
871
|
-
* @nullable
|
|
872
1141
|
*/
|
|
873
|
-
|
|
1142
|
+
interface LeadCondition {
|
|
874
1143
|
/** Salesforce condition record ID */
|
|
875
1144
|
id?: string;
|
|
876
1145
|
/** Human-readable condition name */
|
|
@@ -879,30 +1148,24 @@ type LeadCondition = {
|
|
|
879
1148
|
active?: LeadConditionActive;
|
|
880
1149
|
/** Condition type. soft-condition types omit the verified field in the response. */
|
|
881
1150
|
type?: LeadConditionType;
|
|
882
|
-
/**
|
|
883
|
-
|
|
884
|
-
* @nullable
|
|
885
|
-
*/
|
|
886
|
-
verified?: boolean | null;
|
|
1151
|
+
/** Whether the condition has been verified by underwriting. Absent for soft-condition type. */
|
|
1152
|
+
verified?: LeadConditionVerified;
|
|
887
1153
|
/** Internal condition template identifier */
|
|
888
1154
|
condition_id?: string;
|
|
889
1155
|
/** Applicant or seller response / documentation reference for this condition */
|
|
890
1156
|
condition_response?: string;
|
|
891
|
-
/**
|
|
892
|
-
|
|
893
|
-
|
|
894
|
-
*/
|
|
895
|
-
verified_by_debt_consultant?: boolean | null;
|
|
896
|
-
} | null;
|
|
1157
|
+
/** Whether the condition was verified by a debt consultant */
|
|
1158
|
+
verified_by_debt_consultant?: LeadConditionVerifiedByDebtConsultant;
|
|
1159
|
+
}
|
|
897
1160
|
|
|
898
1161
|
/**
|
|
899
1162
|
* Generated by orval v7.21.0 🍺
|
|
900
1163
|
* Do not edit manually.
|
|
901
1164
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
1165
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
903
1166
|
|
|
904
|
-
**Published:** 2026-
|
|
905
|
-
* OpenAPI spec version: 2026.
|
|
1167
|
+
**Published:** 2026-10-30
|
|
1168
|
+
* OpenAPI spec version: 2026.21.0
|
|
906
1169
|
*/
|
|
907
1170
|
|
|
908
1171
|
/**
|
|
@@ -979,10 +1242,25 @@ interface DebtAccount {
|
|
|
979
1242
|
* Generated by orval v7.21.0 🍺
|
|
980
1243
|
* Do not edit manually.
|
|
981
1244
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
1245
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1246
|
+
|
|
1247
|
+
**Published:** 2026-10-30
|
|
1248
|
+
* OpenAPI spec version: 2026.21.0
|
|
1249
|
+
*/
|
|
1250
|
+
|
|
1251
|
+
/**
|
|
1252
|
+
* List of debt accounts to enroll in the program. Required only when the program response contains CBR-modified or DC-added trade lines (i.e. the program has adjusted or added accounts based on credit bureau data). Optional otherwise when pull_credit_report is true — debt accounts will be sourced from the credit report. When required, forward the debt_accounts array from the program response as-is; the server matches by 'id' and ignores unrecognised fields, so no transformation is needed.
|
|
1253
|
+
*/
|
|
1254
|
+
type CreateLeadRequestDebtAccounts = DebtAccount[] | null;
|
|
1255
|
+
|
|
1256
|
+
/**
|
|
1257
|
+
* Generated by orval v7.21.0 🍺
|
|
1258
|
+
* Do not edit manually.
|
|
1259
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1260
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
983
1261
|
|
|
984
|
-
**Published:** 2026-
|
|
985
|
-
* OpenAPI spec version: 2026.
|
|
1262
|
+
**Published:** 2026-10-30
|
|
1263
|
+
* OpenAPI spec version: 2026.21.0
|
|
986
1264
|
*/
|
|
987
1265
|
|
|
988
1266
|
/**
|
|
@@ -1053,6 +1331,7 @@ interface CreateLeadRequest {
|
|
|
1053
1331
|
scheduled_distribution_date_and_time?: string;
|
|
1054
1332
|
/** Unique distribution identifier */
|
|
1055
1333
|
distribution_identifier?: string;
|
|
1334
|
+
/** Lead distribution routing settings */
|
|
1056
1335
|
lead_distribution?: LeadDistribution;
|
|
1057
1336
|
/** Monthly child care expenses */
|
|
1058
1337
|
child_care?: number;
|
|
@@ -1114,23 +1393,22 @@ interface CreateLeadRequest {
|
|
|
1114
1393
|
other_expenses_description?: string;
|
|
1115
1394
|
/** Free-text comments on income and expenses */
|
|
1116
1395
|
income_expenses_comments?: string;
|
|
1396
|
+
/** Primary applicant details */
|
|
1117
1397
|
applicant?: LeadApplicantInput;
|
|
1398
|
+
/** Co-applicant details (optional) */
|
|
1118
1399
|
co_applicant?: CoApplicant;
|
|
1119
|
-
/**
|
|
1120
|
-
|
|
1121
|
-
* @nullable
|
|
1122
|
-
*/
|
|
1123
|
-
debt_accounts?: DebtAccount[] | null;
|
|
1400
|
+
/** List of debt accounts to enroll in the program. Required only when the program response contains CBR-modified or DC-added trade lines (i.e. the program has adjusted or added accounts based on credit bureau data). Optional otherwise when pull_credit_report is true — debt accounts will be sourced from the credit report. When required, forward the debt_accounts array from the program response as-is; the server matches by 'id' and ignores unrecognised fields, so no transformation is needed. */
|
|
1401
|
+
debt_accounts?: CreateLeadRequestDebtAccounts;
|
|
1124
1402
|
}
|
|
1125
1403
|
|
|
1126
1404
|
/**
|
|
1127
1405
|
* Generated by orval v7.21.0 🍺
|
|
1128
1406
|
* Do not edit manually.
|
|
1129
1407
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
1408
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1131
1409
|
|
|
1132
|
-
**Published:** 2026-
|
|
1133
|
-
* OpenAPI spec version: 2026.
|
|
1410
|
+
**Published:** 2026-10-30
|
|
1411
|
+
* OpenAPI spec version: 2026.21.0
|
|
1134
1412
|
*/
|
|
1135
1413
|
/**
|
|
1136
1414
|
* Current program / opportunity stage
|
|
@@ -1154,10 +1432,10 @@ declare const LeadApplicationStatus: {
|
|
|
1154
1432
|
* Generated by orval v7.21.0 🍺
|
|
1155
1433
|
* Do not edit manually.
|
|
1156
1434
|
* 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.
|
|
1435
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1158
1436
|
|
|
1159
|
-
**Published:** 2026-
|
|
1160
|
-
* OpenAPI spec version: 2026.
|
|
1437
|
+
**Published:** 2026-10-30
|
|
1438
|
+
* OpenAPI spec version: 2026.21.0
|
|
1161
1439
|
*/
|
|
1162
1440
|
/**
|
|
1163
1441
|
* Client's preferred language
|
|
@@ -1172,10 +1450,24 @@ declare const LeadApplicationLanguage: {
|
|
|
1172
1450
|
* Generated by orval v7.21.0 🍺
|
|
1173
1451
|
* Do not edit manually.
|
|
1174
1452
|
* 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.
|
|
1453
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1176
1454
|
|
|
1177
|
-
**Published:** 2026-
|
|
1178
|
-
* OpenAPI spec version: 2026.
|
|
1455
|
+
**Published:** 2026-10-30
|
|
1456
|
+
* OpenAPI spec version: 2026.21.0
|
|
1457
|
+
*/
|
|
1458
|
+
/**
|
|
1459
|
+
* Whether this application passed program eligibility checks
|
|
1460
|
+
*/
|
|
1461
|
+
type LeadApplicationEligible = boolean | null;
|
|
1462
|
+
|
|
1463
|
+
/**
|
|
1464
|
+
* Generated by orval v7.21.0 🍺
|
|
1465
|
+
* Do not edit manually.
|
|
1466
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
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. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1468
|
+
|
|
1469
|
+
**Published:** 2026-10-30
|
|
1470
|
+
* OpenAPI spec version: 2026.21.0
|
|
1179
1471
|
*/
|
|
1180
1472
|
/**
|
|
1181
1473
|
* Bankruptcy status on file
|
|
@@ -1193,10 +1485,39 @@ declare const LeadApplicantBankruptcy: {
|
|
|
1193
1485
|
* Generated by orval v7.21.0 🍺
|
|
1194
1486
|
* Do not edit manually.
|
|
1195
1487
|
* 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.
|
|
1488
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1489
|
+
|
|
1490
|
+
**Published:** 2026-10-30
|
|
1491
|
+
* OpenAPI spec version: 2026.21.0
|
|
1492
|
+
*/
|
|
1493
|
+
|
|
1494
|
+
/**
|
|
1495
|
+
* Conditions associated with this applicant
|
|
1496
|
+
*/
|
|
1497
|
+
type LeadApplicantConditions = LeadCondition[] | null;
|
|
1498
|
+
|
|
1499
|
+
/**
|
|
1500
|
+
* Generated by orval v7.21.0 🍺
|
|
1501
|
+
* Do not edit manually.
|
|
1502
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1503
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1504
|
+
|
|
1505
|
+
**Published:** 2026-10-30
|
|
1506
|
+
* OpenAPI spec version: 2026.21.0
|
|
1507
|
+
*/
|
|
1508
|
+
/**
|
|
1509
|
+
* Eligibility token generated during the eligibility check. Present in eligibility responses; null in other lead responses.
|
|
1510
|
+
*/
|
|
1511
|
+
type LeadApplicantProgramEligibilityToken = string | null;
|
|
1512
|
+
|
|
1513
|
+
/**
|
|
1514
|
+
* Generated by orval v7.21.0 🍺
|
|
1515
|
+
* Do not edit manually.
|
|
1516
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1517
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1197
1518
|
|
|
1198
|
-
**Published:** 2026-
|
|
1199
|
-
* OpenAPI spec version: 2026.
|
|
1519
|
+
**Published:** 2026-10-30
|
|
1520
|
+
* OpenAPI spec version: 2026.21.0
|
|
1200
1521
|
*/
|
|
1201
1522
|
/**
|
|
1202
1523
|
* Pay frequency
|
|
@@ -1216,10 +1537,10 @@ declare const LeadApplicantPayFrequency: {
|
|
|
1216
1537
|
* Generated by orval v7.21.0 🍺
|
|
1217
1538
|
* Do not edit manually.
|
|
1218
1539
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
1540
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1220
1541
|
|
|
1221
|
-
**Published:** 2026-
|
|
1222
|
-
* OpenAPI spec version: 2026.
|
|
1542
|
+
**Published:** 2026-10-30
|
|
1543
|
+
* OpenAPI spec version: 2026.21.0
|
|
1223
1544
|
*/
|
|
1224
1545
|
/**
|
|
1225
1546
|
* Current employment status
|
|
@@ -1238,17 +1559,16 @@ declare const LeadApplicantEmploymentStatus: {
|
|
|
1238
1559
|
* Generated by orval v7.21.0 🍺
|
|
1239
1560
|
* Do not edit manually.
|
|
1240
1561
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
1562
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1242
1563
|
|
|
1243
|
-
**Published:** 2026-
|
|
1244
|
-
* OpenAPI spec version: 2026.
|
|
1564
|
+
**Published:** 2026-10-30
|
|
1565
|
+
* OpenAPI spec version: 2026.21.0
|
|
1245
1566
|
*/
|
|
1246
1567
|
|
|
1247
1568
|
/**
|
|
1248
1569
|
* Applicant or co-applicant personal details
|
|
1249
|
-
* @nullable
|
|
1250
1570
|
*/
|
|
1251
|
-
|
|
1571
|
+
interface LeadApplicant {
|
|
1252
1572
|
/** Salesforce record ID — also echoes fdr_applicant_id value via JOLT mapping */
|
|
1253
1573
|
id?: string;
|
|
1254
1574
|
/** Applicant email address */
|
|
@@ -1265,18 +1585,12 @@ type LeadApplicant = {
|
|
|
1265
1585
|
unemployment?: number;
|
|
1266
1586
|
/** Bankruptcy status on file */
|
|
1267
1587
|
bankruptcy?: LeadApplicantBankruptcy;
|
|
1268
|
-
/**
|
|
1269
|
-
|
|
1270
|
-
* @nullable
|
|
1271
|
-
*/
|
|
1272
|
-
conditions?: LeadCondition[] | null;
|
|
1588
|
+
/** Conditions associated with this applicant */
|
|
1589
|
+
conditions?: LeadApplicantConditions;
|
|
1273
1590
|
/** FDR applicant identifier */
|
|
1274
1591
|
fdr_applicant_id?: string;
|
|
1275
|
-
/**
|
|
1276
|
-
|
|
1277
|
-
* @nullable
|
|
1278
|
-
*/
|
|
1279
|
-
program_eligibility_token?: string | null;
|
|
1592
|
+
/** Eligibility token generated during the eligibility check. Present in eligibility responses; null in other lead responses. */
|
|
1593
|
+
program_eligibility_token?: LeadApplicantProgramEligibilityToken;
|
|
1280
1594
|
/** Credit bureau report ID */
|
|
1281
1595
|
cbr_report_id?: string;
|
|
1282
1596
|
/** Applicant first name */
|
|
@@ -1295,7 +1609,9 @@ type LeadApplicant = {
|
|
|
1295
1609
|
date_of_birth?: string;
|
|
1296
1610
|
/** Social Security Number (masked in logs) */
|
|
1297
1611
|
social_security_number?: string;
|
|
1612
|
+
/** Physical / current address */
|
|
1298
1613
|
current_address?: Address;
|
|
1614
|
+
/** Mailing address, if different from current */
|
|
1299
1615
|
mailing_address?: Address;
|
|
1300
1616
|
/** Applicant's gross monthly income (USD) */
|
|
1301
1617
|
monthly_income?: number;
|
|
@@ -1333,16 +1649,31 @@ type LeadApplicant = {
|
|
|
1333
1649
|
email_opt_out?: boolean;
|
|
1334
1650
|
/** Date of bankruptcy filing (YYYY-MM-DD) */
|
|
1335
1651
|
bankruptcy_date?: string;
|
|
1336
|
-
}
|
|
1652
|
+
}
|
|
1337
1653
|
|
|
1338
1654
|
/**
|
|
1339
1655
|
* Generated by orval v7.21.0 🍺
|
|
1340
1656
|
* Do not edit manually.
|
|
1341
1657
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
1658
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1659
|
+
|
|
1660
|
+
**Published:** 2026-10-30
|
|
1661
|
+
* OpenAPI spec version: 2026.21.0
|
|
1662
|
+
*/
|
|
1343
1663
|
|
|
1344
|
-
|
|
1345
|
-
*
|
|
1664
|
+
/**
|
|
1665
|
+
* Application-level underwriting conditions
|
|
1666
|
+
*/
|
|
1667
|
+
type LeadApplicationConditions = LeadCondition[] | null;
|
|
1668
|
+
|
|
1669
|
+
/**
|
|
1670
|
+
* Generated by orval v7.21.0 🍺
|
|
1671
|
+
* Do not edit manually.
|
|
1672
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1673
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1674
|
+
|
|
1675
|
+
**Published:** 2026-10-30
|
|
1676
|
+
* OpenAPI spec version: 2026.21.0
|
|
1346
1677
|
*/
|
|
1347
1678
|
/**
|
|
1348
1679
|
* Sub-status of the current stage
|
|
@@ -1409,10 +1740,24 @@ declare const LeadApplicationSubStatus: {
|
|
|
1409
1740
|
* Generated by orval v7.21.0 🍺
|
|
1410
1741
|
* Do not edit manually.
|
|
1411
1742
|
* 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.
|
|
1743
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1413
1744
|
|
|
1414
|
-
**Published:** 2026-
|
|
1415
|
-
* OpenAPI spec version: 2026.
|
|
1745
|
+
**Published:** 2026-10-30
|
|
1746
|
+
* OpenAPI spec version: 2026.21.0
|
|
1747
|
+
*/
|
|
1748
|
+
/**
|
|
1749
|
+
* DEX-specific flow status set by the partner integration
|
|
1750
|
+
*/
|
|
1751
|
+
type LeadApplicationDexFlowStatus = string | null;
|
|
1752
|
+
|
|
1753
|
+
/**
|
|
1754
|
+
* Generated by orval v7.21.0 🍺
|
|
1755
|
+
* Do not edit manually.
|
|
1756
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1757
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1758
|
+
|
|
1759
|
+
**Published:** 2026-10-30
|
|
1760
|
+
* OpenAPI spec version: 2026.21.0
|
|
1416
1761
|
*/
|
|
1417
1762
|
/**
|
|
1418
1763
|
* Indicates whether the program is FDR or CSS serviced
|
|
@@ -1427,10 +1772,10 @@ declare const LeadApplicationFdrOrCss: {
|
|
|
1427
1772
|
* Generated by orval v7.21.0 🍺
|
|
1428
1773
|
* Do not edit manually.
|
|
1429
1774
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
1775
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1431
1776
|
|
|
1432
|
-
**Published:** 2026-
|
|
1433
|
-
* OpenAPI spec version: 2026.
|
|
1777
|
+
**Published:** 2026-10-30
|
|
1778
|
+
* OpenAPI spec version: 2026.21.0
|
|
1434
1779
|
*/
|
|
1435
1780
|
/**
|
|
1436
1781
|
* Draft frequency type
|
|
@@ -1446,10 +1791,10 @@ declare const LeadApplicationDraftType: {
|
|
|
1446
1791
|
* Generated by orval v7.21.0 🍺
|
|
1447
1792
|
* Do not edit manually.
|
|
1448
1793
|
* 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.
|
|
1794
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1450
1795
|
|
|
1451
|
-
**Published:** 2026-
|
|
1452
|
-
* OpenAPI spec version: 2026.
|
|
1796
|
+
**Published:** 2026-10-30
|
|
1797
|
+
* OpenAPI spec version: 2026.21.0
|
|
1453
1798
|
*/
|
|
1454
1799
|
/**
|
|
1455
1800
|
* Whether client is on fixed income. Salesforce returns this as the string \"Yes\" or \"No\" (not a boolean).
|
|
@@ -1464,10 +1809,10 @@ declare const LeadApplicationFixedIncome: {
|
|
|
1464
1809
|
* Generated by orval v7.21.0 🍺
|
|
1465
1810
|
* Do not edit manually.
|
|
1466
1811
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
1812
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1468
1813
|
|
|
1469
|
-
**Published:** 2026-
|
|
1470
|
-
* OpenAPI spec version: 2026.
|
|
1814
|
+
**Published:** 2026-10-30
|
|
1815
|
+
* OpenAPI spec version: 2026.21.0
|
|
1471
1816
|
*/
|
|
1472
1817
|
/**
|
|
1473
1818
|
* Whether the client owns or rents their home
|
|
@@ -1482,10 +1827,10 @@ declare const LeadApplicationOwnOrRent: {
|
|
|
1482
1827
|
* Generated by orval v7.21.0 🍺
|
|
1483
1828
|
* Do not edit manually.
|
|
1484
1829
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
1830
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1486
1831
|
|
|
1487
|
-
**Published:** 2026-
|
|
1488
|
-
* OpenAPI spec version: 2026.
|
|
1832
|
+
**Published:** 2026-10-30
|
|
1833
|
+
* OpenAPI spec version: 2026.21.0
|
|
1489
1834
|
*/
|
|
1490
1835
|
/**
|
|
1491
1836
|
* Primary hardship category
|
|
@@ -1504,10 +1849,24 @@ declare const LeadApplicationHardshipCategory: {
|
|
|
1504
1849
|
* Generated by orval v7.21.0 🍺
|
|
1505
1850
|
* Do not edit manually.
|
|
1506
1851
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
1852
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1508
1853
|
|
|
1509
|
-
**Published:** 2026-
|
|
1510
|
-
* OpenAPI spec version: 2026.
|
|
1854
|
+
**Published:** 2026-10-30
|
|
1855
|
+
* OpenAPI spec version: 2026.21.0
|
|
1856
|
+
*/
|
|
1857
|
+
/**
|
|
1858
|
+
* Free-text hardship description when category is 'Other'
|
|
1859
|
+
*/
|
|
1860
|
+
type LeadApplicationHardshipCategoryOther = string | null;
|
|
1861
|
+
|
|
1862
|
+
/**
|
|
1863
|
+
* Generated by orval v7.21.0 🍺
|
|
1864
|
+
* Do not edit manually.
|
|
1865
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1866
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1867
|
+
|
|
1868
|
+
**Published:** 2026-10-30
|
|
1869
|
+
* OpenAPI spec version: 2026.21.0
|
|
1511
1870
|
*/
|
|
1512
1871
|
/**
|
|
1513
1872
|
* Client's primary financial goal category
|
|
@@ -1524,10 +1883,24 @@ declare const LeadApplicationGoalCategory: {
|
|
|
1524
1883
|
* Generated by orval v7.21.0 🍺
|
|
1525
1884
|
* Do not edit manually.
|
|
1526
1885
|
* 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.
|
|
1886
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1528
1887
|
|
|
1529
|
-
**Published:** 2026-
|
|
1530
|
-
* OpenAPI spec version: 2026.
|
|
1888
|
+
**Published:** 2026-10-30
|
|
1889
|
+
* OpenAPI spec version: 2026.21.0
|
|
1890
|
+
*/
|
|
1891
|
+
/**
|
|
1892
|
+
* Free-text goal when category is 'Other'
|
|
1893
|
+
*/
|
|
1894
|
+
type LeadApplicationGoalCategoryOther = string | null;
|
|
1895
|
+
|
|
1896
|
+
/**
|
|
1897
|
+
* Generated by orval v7.21.0 🍺
|
|
1898
|
+
* Do not edit manually.
|
|
1899
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1900
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1901
|
+
|
|
1902
|
+
**Published:** 2026-10-30
|
|
1903
|
+
* OpenAPI spec version: 2026.21.0
|
|
1531
1904
|
*/
|
|
1532
1905
|
/**
|
|
1533
1906
|
* Client's secondary financial goal
|
|
@@ -1548,10 +1921,24 @@ declare const LeadApplicationSecondaryGoal: {
|
|
|
1548
1921
|
* Generated by orval v7.21.0 🍺
|
|
1549
1922
|
* Do not edit manually.
|
|
1550
1923
|
* 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.
|
|
1924
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1925
|
+
|
|
1926
|
+
**Published:** 2026-10-30
|
|
1927
|
+
* OpenAPI spec version: 2026.21.0
|
|
1928
|
+
*/
|
|
1929
|
+
/**
|
|
1930
|
+
* Assigned law firm identifier
|
|
1931
|
+
*/
|
|
1932
|
+
type LeadApplicationLawFirmId = string | null;
|
|
1933
|
+
|
|
1934
|
+
/**
|
|
1935
|
+
* Generated by orval v7.21.0 🍺
|
|
1936
|
+
* Do not edit manually.
|
|
1937
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1938
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1552
1939
|
|
|
1553
|
-
**Published:** 2026-
|
|
1554
|
-
* OpenAPI spec version: 2026.
|
|
1940
|
+
**Published:** 2026-10-30
|
|
1941
|
+
* OpenAPI spec version: 2026.21.0
|
|
1555
1942
|
*/
|
|
1556
1943
|
/**
|
|
1557
1944
|
* Source of the credit report pull (also present inside applicant)
|
|
@@ -1566,10 +1953,55 @@ declare const LeadApplicationCreditPullSource: {
|
|
|
1566
1953
|
* Generated by orval v7.21.0 🍺
|
|
1567
1954
|
* Do not edit manually.
|
|
1568
1955
|
* 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.
|
|
1956
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1570
1957
|
|
|
1571
|
-
**Published:** 2026-
|
|
1572
|
-
* OpenAPI spec version: 2026.
|
|
1958
|
+
**Published:** 2026-10-30
|
|
1959
|
+
* OpenAPI spec version: 2026.21.0
|
|
1960
|
+
*/
|
|
1961
|
+
/**
|
|
1962
|
+
* Primary applicant credit bureau report ID, also present inside applicant.cbr_report_id
|
|
1963
|
+
*/
|
|
1964
|
+
type LeadApplicationCbrReportId = string | null;
|
|
1965
|
+
|
|
1966
|
+
/**
|
|
1967
|
+
* Generated by orval v7.21.0 🍺
|
|
1968
|
+
* Do not edit manually.
|
|
1969
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1970
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1971
|
+
|
|
1972
|
+
**Published:** 2026-10-30
|
|
1973
|
+
* OpenAPI spec version: 2026.21.0
|
|
1974
|
+
*/
|
|
1975
|
+
/**
|
|
1976
|
+
* Co-applicant credit bureau report ID (JOLT special mapping)
|
|
1977
|
+
*/
|
|
1978
|
+
type LeadApplicationCoApplicantCbrReportId = string | null;
|
|
1979
|
+
|
|
1980
|
+
/**
|
|
1981
|
+
* Generated by orval v7.21.0 🍺
|
|
1982
|
+
* Do not edit manually.
|
|
1983
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
1984
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1985
|
+
|
|
1986
|
+
**Published:** 2026-10-30
|
|
1987
|
+
* OpenAPI spec version: 2026.21.0
|
|
1988
|
+
*/
|
|
1989
|
+
|
|
1990
|
+
/**
|
|
1991
|
+
* Co-applicant details, if present
|
|
1992
|
+
|
|
1993
|
+
⚠️ Patched locally by `openapi/repairs.ts` — this differs from FDR's published spec.
|
|
1994
|
+
*/
|
|
1995
|
+
type LeadApplicationCoApplicant = LeadApplicant | null;
|
|
1996
|
+
|
|
1997
|
+
/**
|
|
1998
|
+
* Generated by orval v7.21.0 🍺
|
|
1999
|
+
* Do not edit manually.
|
|
2000
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
2001
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2002
|
+
|
|
2003
|
+
**Published:** 2026-10-30
|
|
2004
|
+
* OpenAPI spec version: 2026.21.0
|
|
1573
2005
|
*/
|
|
1574
2006
|
/**
|
|
1575
2007
|
* Creditor or original creditor details
|
|
@@ -1605,10 +2037,10 @@ interface LeadCreditor {
|
|
|
1605
2037
|
* Generated by orval v7.21.0 🍺
|
|
1606
2038
|
* Do not edit manually.
|
|
1607
2039
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
2040
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1609
2041
|
|
|
1610
|
-
**Published:** 2026-
|
|
1611
|
-
* OpenAPI spec version: 2026.
|
|
2042
|
+
**Published:** 2026-10-30
|
|
2043
|
+
* OpenAPI spec version: 2026.21.0
|
|
1612
2044
|
*/
|
|
1613
2045
|
/**
|
|
1614
2046
|
* Responsibility type for the account
|
|
@@ -1631,10 +2063,10 @@ declare const LeadDebtAccountResponsibility: {
|
|
|
1631
2063
|
* Generated by orval v7.21.0 🍺
|
|
1632
2064
|
* Do not edit manually.
|
|
1633
2065
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1634
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2066
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1635
2067
|
|
|
1636
|
-
**Published:** 2026-
|
|
1637
|
-
* OpenAPI spec version: 2026.
|
|
2068
|
+
**Published:** 2026-10-30
|
|
2069
|
+
* OpenAPI spec version: 2026.21.0
|
|
1638
2070
|
*/
|
|
1639
2071
|
/**
|
|
1640
2072
|
* Ownership of the account
|
|
@@ -1650,10 +2082,10 @@ declare const LeadDebtAccountOwnership: {
|
|
|
1650
2082
|
* Generated by orval v7.21.0 🍺
|
|
1651
2083
|
* Do not edit manually.
|
|
1652
2084
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
2085
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1654
2086
|
|
|
1655
|
-
**Published:** 2026-
|
|
1656
|
-
* OpenAPI spec version: 2026.
|
|
2087
|
+
**Published:** 2026-10-30
|
|
2088
|
+
* OpenAPI spec version: 2026.21.0
|
|
1657
2089
|
*/
|
|
1658
2090
|
/**
|
|
1659
2091
|
* Source of the debt account record
|
|
@@ -1671,10 +2103,39 @@ declare const LeadDebtAccountSource: {
|
|
|
1671
2103
|
* Generated by orval v7.21.0 🍺
|
|
1672
2104
|
* Do not edit manually.
|
|
1673
2105
|
* 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.
|
|
2106
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2107
|
+
|
|
2108
|
+
**Published:** 2026-10-30
|
|
2109
|
+
* OpenAPI spec version: 2026.21.0
|
|
2110
|
+
*/
|
|
2111
|
+
|
|
2112
|
+
/**
|
|
2113
|
+
* Conditions specific to this debt account
|
|
2114
|
+
*/
|
|
2115
|
+
type LeadDebtAccountConditions = LeadCondition[] | null;
|
|
2116
|
+
|
|
2117
|
+
/**
|
|
2118
|
+
* Generated by orval v7.21.0 🍺
|
|
2119
|
+
* Do not edit manually.
|
|
2120
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
2121
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1675
2122
|
|
|
1676
|
-
**Published:** 2026-
|
|
1677
|
-
* OpenAPI spec version: 2026.
|
|
2123
|
+
**Published:** 2026-10-30
|
|
2124
|
+
* OpenAPI spec version: 2026.21.0
|
|
2125
|
+
*/
|
|
2126
|
+
/**
|
|
2127
|
+
* Alternative creditor name when creditor is not in the standard list
|
|
2128
|
+
*/
|
|
2129
|
+
type LeadDebtAccountCurrentCreditorOther = string | null;
|
|
2130
|
+
|
|
2131
|
+
/**
|
|
2132
|
+
* Generated by orval v7.21.0 🍺
|
|
2133
|
+
* Do not edit manually.
|
|
2134
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
2135
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2136
|
+
|
|
2137
|
+
**Published:** 2026-10-30
|
|
2138
|
+
* OpenAPI spec version: 2026.21.0
|
|
1678
2139
|
*/
|
|
1679
2140
|
/**
|
|
1680
2141
|
* Type of account
|
|
@@ -1701,74 +2162,113 @@ declare const LeadDebtAccountAccountType: {
|
|
|
1701
2162
|
readonly 'business-debt-loan': "business-debt-loan";
|
|
1702
2163
|
readonly 'government-debt': "government-debt";
|
|
1703
2164
|
readonly 'legal-fees': "legal-fees";
|
|
2165
|
+
readonly unknown: "unknown";
|
|
1704
2166
|
};
|
|
1705
2167
|
|
|
1706
2168
|
/**
|
|
1707
2169
|
* Generated by orval v7.21.0 🍺
|
|
1708
2170
|
* Do not edit manually.
|
|
1709
2171
|
* 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.
|
|
2172
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2173
|
+
|
|
2174
|
+
**Published:** 2026-10-30
|
|
2175
|
+
* OpenAPI spec version: 2026.21.0
|
|
2176
|
+
*/
|
|
2177
|
+
/**
|
|
2178
|
+
* Credit bureau that reported this tradeline
|
|
2179
|
+
*/
|
|
2180
|
+
type LeadDebtAccountTradelineSource = string | null;
|
|
2181
|
+
|
|
2182
|
+
/**
|
|
2183
|
+
* Generated by orval v7.21.0 🍺
|
|
2184
|
+
* Do not edit manually.
|
|
2185
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
2186
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1711
2187
|
|
|
1712
|
-
**Published:** 2026-
|
|
1713
|
-
* OpenAPI spec version: 2026.
|
|
2188
|
+
**Published:** 2026-10-30
|
|
2189
|
+
* OpenAPI spec version: 2026.21.0
|
|
1714
2190
|
*/
|
|
1715
2191
|
/**
|
|
1716
|
-
*
|
|
2192
|
+
* Universal identifier for the tradeline across credit bureaus
|
|
1717
2193
|
*/
|
|
1718
|
-
type
|
|
1719
|
-
|
|
1720
|
-
|
|
1721
|
-
|
|
2194
|
+
type LeadDebtAccountUniversalId = string | null;
|
|
2195
|
+
|
|
2196
|
+
/**
|
|
2197
|
+
* Generated by orval v7.21.0 🍺
|
|
2198
|
+
* Do not edit manually.
|
|
2199
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
2200
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2201
|
+
|
|
2202
|
+
**Published:** 2026-10-30
|
|
2203
|
+
* OpenAPI spec version: 2026.21.0
|
|
2204
|
+
*/
|
|
2205
|
+
/**
|
|
2206
|
+
* Debt account ineligibility reason code exactly as returned by ARPC. Values may be labels or codes; preserve case and spaces. Additional values may be returned.
|
|
2207
|
+
*/
|
|
2208
|
+
type DebtAccountIneligibilityReasonReasonId = typeof DebtAccountIneligibilityReasonReasonId[keyof typeof DebtAccountIneligibilityReasonReasonId];
|
|
2209
|
+
declare const DebtAccountIneligibilityReasonReasonId: {
|
|
2210
|
+
readonly '3rd_Party_Joint_Accounts_California': "3rd Party Joint Accounts California";
|
|
2211
|
+
readonly 'C-Plus_-_Conflict_of_Interest': "C-Plus - Conflict of Interest";
|
|
2212
|
+
readonly Debt_Too_Low: "Debt Too Low";
|
|
2213
|
+
readonly Duplicate_Account: "Duplicate Account";
|
|
2214
|
+
readonly Education: "Education";
|
|
2215
|
+
readonly Equipment: "Equipment";
|
|
2216
|
+
readonly 'F-Plus_-_Conflict_of_Interest': "F-Plus - Conflict of Interest";
|
|
2217
|
+
readonly Government: "Government";
|
|
2218
|
+
readonly Insurance: "Insurance";
|
|
2219
|
+
readonly Legal_Fees: "Legal Fees";
|
|
2220
|
+
readonly Mortgage: "Mortgage";
|
|
2221
|
+
readonly Responsibility: "Responsibility";
|
|
2222
|
+
readonly Secured_Loan: "Secured Loan";
|
|
2223
|
+
readonly Unacceptable_Creditor: "Unacceptable Creditor";
|
|
2224
|
+
readonly 'co-applicant-not-enrolled': "co-applicant-not-enrolled";
|
|
1722
2225
|
readonly 'conflict-of-interest-ffam-cplus-balance': "conflict-of-interest-ffam-cplus-balance";
|
|
1723
2226
|
readonly 'conflict-of-interest-ffam-fplus-balance': "conflict-of-interest-ffam-fplus-balance";
|
|
1724
|
-
readonly '
|
|
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";
|
|
2227
|
+
readonly 'external-debt-acceleration-loan': "external-debt-acceleration-loan";
|
|
1735
2228
|
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
2229
|
};
|
|
1744
2230
|
|
|
1745
2231
|
/**
|
|
1746
2232
|
* Generated by orval v7.21.0 🍺
|
|
1747
2233
|
* Do not edit manually.
|
|
1748
2234
|
* 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.
|
|
2235
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1750
2236
|
|
|
1751
|
-
**Published:** 2026-
|
|
1752
|
-
* OpenAPI spec version: 2026.
|
|
2237
|
+
**Published:** 2026-10-30
|
|
2238
|
+
* OpenAPI spec version: 2026.21.0
|
|
1753
2239
|
*/
|
|
1754
2240
|
|
|
1755
2241
|
/**
|
|
1756
|
-
*
|
|
1757
|
-
* @nullable
|
|
2242
|
+
* Individual debt-account ineligibility reason; does not by itself imply program ineligibility
|
|
1758
2243
|
*/
|
|
1759
|
-
|
|
1760
|
-
/**
|
|
1761
|
-
reason_id?:
|
|
1762
|
-
}
|
|
2244
|
+
interface DebtAccountIneligibilityReason {
|
|
2245
|
+
/** Debt account ineligibility reason code exactly as returned by ARPC. Values may be labels or codes; preserve case and spaces. Additional values may be returned. */
|
|
2246
|
+
reason_id?: DebtAccountIneligibilityReasonReasonId;
|
|
2247
|
+
}
|
|
1763
2248
|
|
|
1764
2249
|
/**
|
|
1765
2250
|
* Generated by orval v7.21.0 🍺
|
|
1766
2251
|
* Do not edit manually.
|
|
1767
2252
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
2253
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1769
2254
|
|
|
1770
|
-
**Published:** 2026-
|
|
1771
|
-
* OpenAPI spec version: 2026.
|
|
2255
|
+
**Published:** 2026-10-30
|
|
2256
|
+
* OpenAPI spec version: 2026.21.0
|
|
2257
|
+
*/
|
|
2258
|
+
|
|
2259
|
+
/**
|
|
2260
|
+
* Reasons this account is ineligible for the program, if any. Normalised from a comma-separated string to an array of reason objects.
|
|
2261
|
+
*/
|
|
2262
|
+
type LeadDebtAccountIneligibleReason = DebtAccountIneligibilityReason[] | null;
|
|
2263
|
+
|
|
2264
|
+
/**
|
|
2265
|
+
* Generated by orval v7.21.0 🍺
|
|
2266
|
+
* Do not edit manually.
|
|
2267
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
2268
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2269
|
+
|
|
2270
|
+
**Published:** 2026-10-30
|
|
2271
|
+
* OpenAPI spec version: 2026.21.0
|
|
1772
2272
|
*/
|
|
1773
2273
|
|
|
1774
2274
|
/**
|
|
@@ -1779,6 +2279,7 @@ interface LeadDebtAccount {
|
|
|
1779
2279
|
id?: string;
|
|
1780
2280
|
/** Salesforce record name */
|
|
1781
2281
|
name?: string;
|
|
2282
|
+
/** Current creditor details */
|
|
1782
2283
|
creditor?: LeadCreditor;
|
|
1783
2284
|
/** Number of months in the account's term */
|
|
1784
2285
|
terms?: number;
|
|
@@ -1796,24 +2297,21 @@ interface LeadDebtAccount {
|
|
|
1796
2297
|
rank?: number;
|
|
1797
2298
|
/** Whether this debt account has been verified by underwriting. Converted from Salesforce Yes/No string to boolean. */
|
|
1798
2299
|
verified?: boolean;
|
|
1799
|
-
/**
|
|
1800
|
-
|
|
1801
|
-
|
|
1802
|
-
|
|
1803
|
-
conditions?: LeadCondition[] | null;
|
|
2300
|
+
/** Conditions specific to this debt account */
|
|
2301
|
+
conditions?: LeadDebtAccountConditions;
|
|
2302
|
+
/** Seller-assigned debt account reference ID */
|
|
2303
|
+
reference_id?: string;
|
|
1804
2304
|
/** External lead platform identifier for this account */
|
|
1805
2305
|
lead_platform_id?: string;
|
|
1806
2306
|
/** Credit bureau trade-line ID */
|
|
1807
2307
|
credit_report_trade_line_id?: string;
|
|
1808
2308
|
/** Display name of the current creditor (from meta-creditor other_name) */
|
|
1809
2309
|
creditor_name?: string;
|
|
1810
|
-
/**
|
|
1811
|
-
|
|
1812
|
-
* @nullable
|
|
1813
|
-
*/
|
|
1814
|
-
current_creditor_other?: string | null;
|
|
2310
|
+
/** Alternative creditor name when creditor is not in the standard list */
|
|
2311
|
+
current_creditor_other?: LeadDebtAccountCurrentCreditorOther;
|
|
1815
2312
|
/** Display name of the original creditor. Falls back to original_creditor.name when other_name is absent. */
|
|
1816
2313
|
original_creditor_name?: string;
|
|
2314
|
+
/** Original creditor details */
|
|
1817
2315
|
original_creditor?: LeadCreditor;
|
|
1818
2316
|
/** Creditor account number */
|
|
1819
2317
|
account_number?: string;
|
|
@@ -1863,16 +2361,10 @@ interface LeadDebtAccount {
|
|
|
1863
2361
|
credit_utilization?: string;
|
|
1864
2362
|
/** Most recent delinquency bucket reported */
|
|
1865
2363
|
most_recent_delinquency?: string;
|
|
1866
|
-
/**
|
|
1867
|
-
|
|
1868
|
-
|
|
1869
|
-
|
|
1870
|
-
tradeline_source?: string | null;
|
|
1871
|
-
/**
|
|
1872
|
-
* Universal identifier for the tradeline across credit bureaus
|
|
1873
|
-
* @nullable
|
|
1874
|
-
*/
|
|
1875
|
-
universal_id?: string | null;
|
|
2364
|
+
/** Credit bureau that reported this tradeline */
|
|
2365
|
+
tradeline_source?: LeadDebtAccountTradelineSource;
|
|
2366
|
+
/** Universal identifier for the tradeline across credit bureaus */
|
|
2367
|
+
universal_id?: LeadDebtAccountUniversalId;
|
|
1876
2368
|
/** First name of the joint account holder, if applicable */
|
|
1877
2369
|
joint_holder_first_name?: string;
|
|
1878
2370
|
/** Last name of the joint account holder, if applicable */
|
|
@@ -1885,69 +2377,71 @@ interface LeadDebtAccount {
|
|
|
1885
2377
|
months_to_settle?: string;
|
|
1886
2378
|
/** True when this debt account belongs to the co-applicant */
|
|
1887
2379
|
co_applicant?: boolean;
|
|
1888
|
-
/**
|
|
1889
|
-
|
|
1890
|
-
* @nullable
|
|
1891
|
-
*/
|
|
1892
|
-
ineligible_reason?: IneligibleReason[] | null;
|
|
2380
|
+
/** Reasons this account is ineligible for the program, if any. Normalised from a comma-separated string to an array of reason objects. */
|
|
2381
|
+
ineligible_reason?: LeadDebtAccountIneligibleReason;
|
|
1893
2382
|
}
|
|
1894
2383
|
|
|
1895
2384
|
/**
|
|
1896
2385
|
* Generated by orval v7.21.0 🍺
|
|
1897
2386
|
* Do not edit manually.
|
|
1898
2387
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
2388
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1900
2389
|
|
|
1901
|
-
**Published:** 2026-
|
|
1902
|
-
* OpenAPI spec version: 2026.
|
|
2390
|
+
**Published:** 2026-10-30
|
|
2391
|
+
* OpenAPI spec version: 2026.21.0
|
|
1903
2392
|
*/
|
|
1904
2393
|
/**
|
|
1905
2394
|
* Tier label for this payment option
|
|
1906
|
-
* @nullable
|
|
1907
2395
|
*/
|
|
1908
|
-
type PaymentOptionEvaluationType =
|
|
1909
|
-
declare const PaymentOptionEvaluationType: {
|
|
1910
|
-
readonly Most_Affordable: "Most Affordable";
|
|
1911
|
-
readonly Best_Value: "Best Value";
|
|
1912
|
-
readonly Fastest: "Fastest";
|
|
1913
|
-
};
|
|
2396
|
+
type PaymentOptionEvaluationType = 'Most Affordable' | 'Best Value' | 'Fastest' | null;
|
|
1914
2397
|
|
|
1915
2398
|
/**
|
|
1916
2399
|
* Generated by orval v7.21.0 🍺
|
|
1917
2400
|
* Do not edit manually.
|
|
1918
2401
|
* 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.
|
|
2402
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1920
2403
|
|
|
1921
|
-
**Published:** 2026-
|
|
1922
|
-
* OpenAPI spec version: 2026.
|
|
2404
|
+
**Published:** 2026-10-30
|
|
2405
|
+
* OpenAPI spec version: 2026.21.0
|
|
1923
2406
|
*/
|
|
1924
2407
|
|
|
1925
2408
|
/**
|
|
1926
2409
|
* A single selectable payment option
|
|
1927
|
-
* @nullable
|
|
1928
2410
|
*/
|
|
1929
|
-
|
|
2411
|
+
interface PaymentOption {
|
|
1930
2412
|
/** Monthly deposit amount for this option (USD) */
|
|
1931
2413
|
monthly_deposit?: number;
|
|
1932
2414
|
/** Total program cost for this option (USD) */
|
|
1933
2415
|
program_cost?: number;
|
|
1934
2416
|
/** Program length for this option (months) */
|
|
1935
2417
|
program_length?: number;
|
|
1936
|
-
/**
|
|
1937
|
-
* Tier label for this payment option
|
|
1938
|
-
* @nullable
|
|
1939
|
-
*/
|
|
2418
|
+
/** Tier label for this payment option */
|
|
1940
2419
|
evaluation_type?: PaymentOptionEvaluationType;
|
|
1941
|
-
}
|
|
2420
|
+
}
|
|
2421
|
+
|
|
2422
|
+
/**
|
|
2423
|
+
* Generated by orval v7.21.0 🍺
|
|
2424
|
+
* Do not edit manually.
|
|
2425
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
2426
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2427
|
+
|
|
2428
|
+
**Published:** 2026-10-30
|
|
2429
|
+
* OpenAPI spec version: 2026.21.0
|
|
2430
|
+
*/
|
|
2431
|
+
|
|
2432
|
+
/**
|
|
2433
|
+
* Selectable payment options (3 tiers)
|
|
2434
|
+
*/
|
|
2435
|
+
type LeadApplicationPaymentOptions = PaymentOption[] | null;
|
|
1942
2436
|
|
|
1943
2437
|
/**
|
|
1944
2438
|
* Generated by orval v7.21.0 🍺
|
|
1945
2439
|
* Do not edit manually.
|
|
1946
2440
|
* 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.
|
|
2441
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1948
2442
|
|
|
1949
|
-
**Published:** 2026-
|
|
1950
|
-
* OpenAPI spec version: 2026.
|
|
2443
|
+
**Published:** 2026-10-30
|
|
2444
|
+
* OpenAPI spec version: 2026.21.0
|
|
1951
2445
|
*/
|
|
1952
2446
|
/**
|
|
1953
2447
|
* Draft frequency type
|
|
@@ -1963,10 +2457,10 @@ declare const PaymentScheduleDraftType: {
|
|
|
1963
2457
|
* Generated by orval v7.21.0 🍺
|
|
1964
2458
|
* Do not edit manually.
|
|
1965
2459
|
* 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.
|
|
2460
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1967
2461
|
|
|
1968
|
-
**Published:** 2026-
|
|
1969
|
-
* OpenAPI spec version: 2026.
|
|
2462
|
+
**Published:** 2026-10-30
|
|
2463
|
+
* OpenAPI spec version: 2026.21.0
|
|
1970
2464
|
*/
|
|
1971
2465
|
|
|
1972
2466
|
/**
|
|
@@ -1987,10 +2481,10 @@ interface PaymentSchedule {
|
|
|
1987
2481
|
* Generated by orval v7.21.0 🍺
|
|
1988
2482
|
* Do not edit manually.
|
|
1989
2483
|
* 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.
|
|
2484
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1991
2485
|
|
|
1992
|
-
**Published:** 2026-
|
|
1993
|
-
* OpenAPI spec version: 2026.
|
|
2486
|
+
**Published:** 2026-10-30
|
|
2487
|
+
* OpenAPI spec version: 2026.21.0
|
|
1994
2488
|
*/
|
|
1995
2489
|
/**
|
|
1996
2490
|
* Tier label for this schedule option
|
|
@@ -2006,17 +2500,16 @@ declare const PaymentScheduleOptionEvaluationType: {
|
|
|
2006
2500
|
* Generated by orval v7.21.0 🍺
|
|
2007
2501
|
* Do not edit manually.
|
|
2008
2502
|
* 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.
|
|
2503
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2010
2504
|
|
|
2011
|
-
**Published:** 2026-
|
|
2012
|
-
* OpenAPI spec version: 2026.
|
|
2505
|
+
**Published:** 2026-10-30
|
|
2506
|
+
* OpenAPI spec version: 2026.21.0
|
|
2013
2507
|
*/
|
|
2014
2508
|
|
|
2015
2509
|
/**
|
|
2016
2510
|
* A payment tier with three draft-frequency schedule breakdowns
|
|
2017
|
-
* @nullable
|
|
2018
2511
|
*/
|
|
2019
|
-
|
|
2512
|
+
interface PaymentScheduleOption {
|
|
2020
2513
|
/** Schedule option identifier */
|
|
2021
2514
|
id?: string;
|
|
2022
2515
|
/** Available draft schedules for this option (regular, split, bi-weekly) */
|
|
@@ -2027,16 +2520,104 @@ type PaymentScheduleOption = {
|
|
|
2027
2520
|
program_length?: number;
|
|
2028
2521
|
/** Total program cost for this option (USD) */
|
|
2029
2522
|
program_cost?: number;
|
|
2030
|
-
}
|
|
2523
|
+
}
|
|
2524
|
+
|
|
2525
|
+
/**
|
|
2526
|
+
* Generated by orval v7.21.0 🍺
|
|
2527
|
+
* Do not edit manually.
|
|
2528
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
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. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2530
|
+
|
|
2531
|
+
**Published:** 2026-10-30
|
|
2532
|
+
* OpenAPI spec version: 2026.21.0
|
|
2533
|
+
*/
|
|
2534
|
+
|
|
2535
|
+
/**
|
|
2536
|
+
* 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.
|
|
2537
|
+
*/
|
|
2538
|
+
type LeadApplicationPaymentScheduleOptions = PaymentScheduleOption[] | null;
|
|
2539
|
+
|
|
2540
|
+
/**
|
|
2541
|
+
* Generated by orval v7.21.0 🍺
|
|
2542
|
+
* Do not edit manually.
|
|
2543
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
2544
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2545
|
+
|
|
2546
|
+
**Published:** 2026-10-30
|
|
2547
|
+
* OpenAPI spec version: 2026.21.0
|
|
2548
|
+
*/
|
|
2549
|
+
|
|
2550
|
+
/**
|
|
2551
|
+
* Bank account details for programme drafts
|
|
2552
|
+
|
|
2553
|
+
⚠️ Patched locally by `openapi/repairs.ts` — this differs from FDR's published spec.
|
|
2554
|
+
*/
|
|
2555
|
+
type LeadApplicationBankDetails = BankDetails | null;
|
|
2556
|
+
|
|
2557
|
+
/**
|
|
2558
|
+
* Generated by orval v7.21.0 🍺
|
|
2559
|
+
* Do not edit manually.
|
|
2560
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
2561
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2562
|
+
|
|
2563
|
+
**Published:** 2026-10-30
|
|
2564
|
+
* OpenAPI spec version: 2026.21.0
|
|
2565
|
+
*/
|
|
2566
|
+
/**
|
|
2567
|
+
* Program ineligibility reason code exactly as returned by ARPC. Values may be labels or codes; preserve case and spaces. Additional values may be returned.
|
|
2568
|
+
*/
|
|
2569
|
+
type ProgramIneligibilityReasonReasonId = typeof ProgramIneligibilityReasonReasonId[keyof typeof ProgramIneligibilityReasonReasonId];
|
|
2570
|
+
declare const ProgramIneligibilityReasonReasonId: {
|
|
2571
|
+
readonly Debt_Too_Low: "Debt Too Low";
|
|
2572
|
+
readonly 'conflict-of-interest-ffam-cplus-balance': "conflict-of-interest-ffam-cplus-balance";
|
|
2573
|
+
readonly 'debt-too-low': "debt-too-low";
|
|
2574
|
+
readonly 'external-debt-acceleration-loan': "external-debt-acceleration-loan";
|
|
2575
|
+
readonly 'fico-too-low': "fico-too-low";
|
|
2576
|
+
readonly 'npv-too-low': "npv-too-low";
|
|
2577
|
+
readonly 'single-creditor-mix-ineligible': "single-creditor-mix-ineligible";
|
|
2578
|
+
};
|
|
2579
|
+
|
|
2580
|
+
/**
|
|
2581
|
+
* Generated by orval v7.21.0 🍺
|
|
2582
|
+
* Do not edit manually.
|
|
2583
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
2584
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2585
|
+
|
|
2586
|
+
**Published:** 2026-10-30
|
|
2587
|
+
* OpenAPI spec version: 2026.21.0
|
|
2588
|
+
*/
|
|
2589
|
+
|
|
2590
|
+
/**
|
|
2591
|
+
* Program-level ineligibility reason, not an individual debt-account reason
|
|
2592
|
+
*/
|
|
2593
|
+
interface ProgramIneligibilityReason {
|
|
2594
|
+
/** Program ineligibility reason code exactly as returned by ARPC. Values may be labels or codes; preserve case and spaces. Additional values may be returned. */
|
|
2595
|
+
reason_id?: ProgramIneligibilityReasonReasonId;
|
|
2596
|
+
}
|
|
2597
|
+
|
|
2598
|
+
/**
|
|
2599
|
+
* Generated by orval v7.21.0 🍺
|
|
2600
|
+
* Do not edit manually.
|
|
2601
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
2602
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2603
|
+
|
|
2604
|
+
**Published:** 2026-10-30
|
|
2605
|
+
* OpenAPI spec version: 2026.21.0
|
|
2606
|
+
*/
|
|
2607
|
+
|
|
2608
|
+
/**
|
|
2609
|
+
* Program-level reasons the application is ineligible, if any. Normalised from a comma-separated string to an array of reason objects.
|
|
2610
|
+
*/
|
|
2611
|
+
type LeadApplicationIneligibleReason = ProgramIneligibilityReason[] | null;
|
|
2031
2612
|
|
|
2032
2613
|
/**
|
|
2033
2614
|
* Generated by orval v7.21.0 🍺
|
|
2034
2615
|
* Do not edit manually.
|
|
2035
2616
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
2617
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2037
2618
|
|
|
2038
|
-
**Published:** 2026-
|
|
2039
|
-
* OpenAPI spec version: 2026.
|
|
2619
|
+
**Published:** 2026-10-30
|
|
2620
|
+
* OpenAPI spec version: 2026.21.0
|
|
2040
2621
|
*/
|
|
2041
2622
|
|
|
2042
2623
|
/**
|
|
@@ -2049,11 +2630,8 @@ interface LeadApplication {
|
|
|
2049
2630
|
state?: string;
|
|
2050
2631
|
/** Client's preferred language */
|
|
2051
2632
|
language?: LeadApplicationLanguage;
|
|
2052
|
-
/**
|
|
2053
|
-
|
|
2054
|
-
* @nullable
|
|
2055
|
-
*/
|
|
2056
|
-
eligible?: boolean | null;
|
|
2633
|
+
/** Whether this application passed program eligibility checks */
|
|
2634
|
+
eligible?: LeadApplicationEligible;
|
|
2057
2635
|
/** Program type / form type */
|
|
2058
2636
|
type?: string;
|
|
2059
2637
|
/** Responsibility level of the current owner (e.g. Debt Consultant, Underwriter) */
|
|
@@ -2062,19 +2640,14 @@ interface LeadApplication {
|
|
|
2062
2640
|
refreshed?: boolean;
|
|
2063
2641
|
/** Monthly utilities expenses (USD) */
|
|
2064
2642
|
utilities?: number;
|
|
2643
|
+
/** Primary applicant details */
|
|
2065
2644
|
applicant?: LeadApplicant;
|
|
2066
|
-
/**
|
|
2067
|
-
|
|
2068
|
-
* @nullable
|
|
2069
|
-
*/
|
|
2070
|
-
conditions?: LeadCondition[] | null;
|
|
2645
|
+
/** Application-level underwriting conditions */
|
|
2646
|
+
conditions?: LeadApplicationConditions;
|
|
2071
2647
|
/** Sub-status of the current stage */
|
|
2072
2648
|
sub_status?: LeadApplicationSubStatus;
|
|
2073
|
-
/**
|
|
2074
|
-
|
|
2075
|
-
* @nullable
|
|
2076
|
-
*/
|
|
2077
|
-
dex_flow_status?: string | null;
|
|
2649
|
+
/** DEX-specific flow status set by the partner integration */
|
|
2650
|
+
dex_flow_status?: LeadApplicationDexFlowStatus;
|
|
2078
2651
|
/** Indicates whether the program is FDR or CSS serviced */
|
|
2079
2652
|
fdr_or_css?: LeadApplicationFdrOrCss;
|
|
2080
2653
|
/** Whether this application has a co-applicant */
|
|
@@ -2231,18 +2804,12 @@ interface LeadApplication {
|
|
|
2231
2804
|
other_expenses_describe?: number;
|
|
2232
2805
|
/** Primary hardship category */
|
|
2233
2806
|
hardship_category?: LeadApplicationHardshipCategory;
|
|
2234
|
-
/**
|
|
2235
|
-
|
|
2236
|
-
* @nullable
|
|
2237
|
-
*/
|
|
2238
|
-
hardship_category_other?: string | null;
|
|
2807
|
+
/** Free-text hardship description when category is 'Other' */
|
|
2808
|
+
hardship_category_other?: LeadApplicationHardshipCategoryOther;
|
|
2239
2809
|
/** Client's primary financial goal category */
|
|
2240
2810
|
goal_category?: LeadApplicationGoalCategory;
|
|
2241
|
-
/**
|
|
2242
|
-
|
|
2243
|
-
* @nullable
|
|
2244
|
-
*/
|
|
2245
|
-
goal_category_other?: string | null;
|
|
2811
|
+
/** Free-text goal when category is 'Other' */
|
|
2812
|
+
goal_category_other?: LeadApplicationGoalCategoryOther;
|
|
2246
2813
|
/** Client's secondary financial goal */
|
|
2247
2814
|
secondary_goal?: LeadApplicationSecondaryGoal;
|
|
2248
2815
|
/** Justification for housing cost amount */
|
|
@@ -2263,11 +2830,8 @@ interface LeadApplication {
|
|
|
2263
2830
|
negative_cash_flow_grounds_for_exception?: string;
|
|
2264
2831
|
/** Justification for net income amount */
|
|
2265
2832
|
income_justification?: string;
|
|
2266
|
-
/**
|
|
2267
|
-
|
|
2268
|
-
* @nullable
|
|
2269
|
-
*/
|
|
2270
|
-
law_firm_id?: string | null;
|
|
2833
|
+
/** Assigned law firm identifier */
|
|
2834
|
+
law_firm_id?: LeadApplicationLawFirmId;
|
|
2271
2835
|
/** Salesforce record creation timestamp */
|
|
2272
2836
|
created_date?: string;
|
|
2273
2837
|
/** Salesforce record close date (YYYY-MM-DD) */
|
|
@@ -2331,48 +2895,39 @@ interface LeadApplication {
|
|
|
2331
2895
|
/** Date of credit report pull (YYYY-MM-DD) */
|
|
2332
2896
|
credit_pull_date?: string;
|
|
2333
2897
|
/** Whether the consent disclosure has been checked */
|
|
2334
|
-
consent_checked?: boolean;
|
|
2335
|
-
/** Whether IDQ (Identity Quality) check has been completed */
|
|
2336
|
-
idq_checked?: boolean;
|
|
2337
|
-
/**
|
|
2338
|
-
|
|
2339
|
-
|
|
2340
|
-
|
|
2341
|
-
|
|
2342
|
-
|
|
2343
|
-
|
|
2344
|
-
|
|
2345
|
-
|
|
2346
|
-
|
|
2347
|
-
|
|
2348
|
-
|
|
2349
|
-
|
|
2350
|
-
|
|
2351
|
-
|
|
2352
|
-
|
|
2353
|
-
|
|
2354
|
-
|
|
2355
|
-
/**
|
|
2356
|
-
|
|
2357
|
-
* @nullable
|
|
2358
|
-
*/
|
|
2359
|
-
payment_schedule_options?: PaymentScheduleOption[] | null;
|
|
2360
|
-
bank_details?: BankDetails;
|
|
2361
|
-
/**
|
|
2362
|
-
* Reasons the application is ineligible, if any. Normalised from a comma-separated string to an array of reason objects.
|
|
2363
|
-
* @nullable
|
|
2364
|
-
*/
|
|
2365
|
-
ineligible_reason?: IneligibleReason[] | null;
|
|
2898
|
+
consent_checked?: boolean;
|
|
2899
|
+
/** Whether IDQ (Identity Quality) check has been completed */
|
|
2900
|
+
idq_checked?: boolean;
|
|
2901
|
+
/** Primary applicant credit bureau report ID, also present inside applicant.cbr_report_id */
|
|
2902
|
+
cbr_report_id?: LeadApplicationCbrReportId;
|
|
2903
|
+
/** Co-applicant credit bureau report ID (JOLT special mapping) */
|
|
2904
|
+
co_applicant_cbr_report_id?: LeadApplicationCoApplicantCbrReportId;
|
|
2905
|
+
/** Co-applicant details, if present
|
|
2906
|
+
|
|
2907
|
+
⚠️ Patched locally by `openapi/repairs.ts` — this differs from FDR's published spec. */
|
|
2908
|
+
co_applicant?: LeadApplicationCoApplicant;
|
|
2909
|
+
/** Debt accounts associated with this application */
|
|
2910
|
+
debt_accounts?: LeadDebtAccount[];
|
|
2911
|
+
/** Selectable payment options (3 tiers) */
|
|
2912
|
+
payment_options?: LeadApplicationPaymentOptions;
|
|
2913
|
+
/** 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. */
|
|
2914
|
+
payment_schedule_options?: LeadApplicationPaymentScheduleOptions;
|
|
2915
|
+
/** Bank account details for programme drafts
|
|
2916
|
+
|
|
2917
|
+
⚠️ Patched locally by `openapi/repairs.ts` — this differs from FDR's published spec. */
|
|
2918
|
+
bank_details?: LeadApplicationBankDetails;
|
|
2919
|
+
/** Program-level reasons the application is ineligible, if any. Normalised from a comma-separated string to an array of reason objects. */
|
|
2920
|
+
ineligible_reason?: LeadApplicationIneligibleReason;
|
|
2366
2921
|
}
|
|
2367
2922
|
|
|
2368
2923
|
/**
|
|
2369
2924
|
* Generated by orval v7.21.0 🍺
|
|
2370
2925
|
* Do not edit manually.
|
|
2371
2926
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
2927
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2373
2928
|
|
|
2374
|
-
**Published:** 2026-
|
|
2375
|
-
* OpenAPI spec version: 2026.
|
|
2929
|
+
**Published:** 2026-10-30
|
|
2930
|
+
* OpenAPI spec version: 2026.21.0
|
|
2376
2931
|
*/
|
|
2377
2932
|
|
|
2378
2933
|
/**
|
|
@@ -2385,6 +2940,7 @@ interface CreateLeadResponse {
|
|
|
2385
2940
|
fdr_applicant_id?: string;
|
|
2386
2941
|
/** Human-readable result message */
|
|
2387
2942
|
message?: string;
|
|
2943
|
+
/** Full application object including program offer, debt accounts, and conditions */
|
|
2388
2944
|
application?: LeadApplication;
|
|
2389
2945
|
}
|
|
2390
2946
|
|
|
@@ -2392,28 +2948,27 @@ interface CreateLeadResponse {
|
|
|
2392
2948
|
* Generated by orval v7.21.0 🍺
|
|
2393
2949
|
* Do not edit manually.
|
|
2394
2950
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
2951
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2396
2952
|
|
|
2397
|
-
**Published:** 2026-
|
|
2398
|
-
* OpenAPI spec version: 2026.
|
|
2953
|
+
**Published:** 2026-10-30
|
|
2954
|
+
* OpenAPI spec version: 2026.21.0
|
|
2399
2955
|
*/
|
|
2400
2956
|
/**
|
|
2401
2957
|
* Consent record for soft credit pull
|
|
2402
|
-
* @nullable
|
|
2403
2958
|
*/
|
|
2404
|
-
|
|
2959
|
+
interface CreditPullConsent {
|
|
2405
2960
|
/** ISO-8601 datetime when consent was obtained (must start with YYYY-MM-DD) */
|
|
2406
2961
|
date_time: string;
|
|
2407
|
-
}
|
|
2962
|
+
}
|
|
2408
2963
|
|
|
2409
2964
|
/**
|
|
2410
2965
|
* Generated by orval v7.21.0 🍺
|
|
2411
2966
|
* Do not edit manually.
|
|
2412
2967
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
2968
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2414
2969
|
|
|
2415
|
-
**Published:** 2026-
|
|
2416
|
-
* OpenAPI spec version: 2026.
|
|
2970
|
+
**Published:** 2026-10-30
|
|
2971
|
+
* OpenAPI spec version: 2026.21.0
|
|
2417
2972
|
*/
|
|
2418
2973
|
/**
|
|
2419
2974
|
* Applicant signing URL details
|
|
@@ -2427,10 +2982,10 @@ interface DraApplicant {
|
|
|
2427
2982
|
* Generated by orval v7.21.0 🍺
|
|
2428
2983
|
* Do not edit manually.
|
|
2429
2984
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
2985
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2431
2986
|
|
|
2432
|
-
**Published:** 2026-
|
|
2433
|
-
* OpenAPI spec version: 2026.
|
|
2987
|
+
**Published:** 2026-10-30
|
|
2988
|
+
* OpenAPI spec version: 2026.21.0
|
|
2434
2989
|
*/
|
|
2435
2990
|
/**
|
|
2436
2991
|
* DocuSign signing method. Use 'url' for embedded signing, 'email' for standard email signing.
|
|
@@ -2445,10 +3000,10 @@ declare const DraApplicantInputSigningType: {
|
|
|
2445
3000
|
* Generated by orval v7.21.0 🍺
|
|
2446
3001
|
* Do not edit manually.
|
|
2447
3002
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
3003
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2449
3004
|
|
|
2450
|
-
**Published:** 2026-
|
|
2451
|
-
* OpenAPI spec version: 2026.
|
|
3005
|
+
**Published:** 2026-10-30
|
|
3006
|
+
* OpenAPI spec version: 2026.21.0
|
|
2452
3007
|
*/
|
|
2453
3008
|
|
|
2454
3009
|
/**
|
|
@@ -2463,10 +3018,10 @@ interface DraApplicantInput {
|
|
|
2463
3018
|
* Generated by orval v7.21.0 🍺
|
|
2464
3019
|
* Do not edit manually.
|
|
2465
3020
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
3021
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2467
3022
|
|
|
2468
|
-
**Published:** 2026-
|
|
2469
|
-
* OpenAPI spec version: 2026.
|
|
3023
|
+
**Published:** 2026-10-30
|
|
3024
|
+
* OpenAPI spec version: 2026.21.0
|
|
2470
3025
|
*/
|
|
2471
3026
|
|
|
2472
3027
|
/**
|
|
@@ -2475,23 +3030,27 @@ interface DraApplicantInput {
|
|
|
2475
3030
|
interface DraRequest {
|
|
2476
3031
|
/** URL to redirect the applicant to after completing or declining the DocuSign session */
|
|
2477
3032
|
returning_url?: string;
|
|
3033
|
+
/** Applicant signing preferences */
|
|
2478
3034
|
applicant?: DraApplicantInput;
|
|
3035
|
+
/** Applicant credit utilization value forwarded to the downstream lead during the DRA generation proxy PATCH. Optional; omitted values leave the field unchanged downstream. */
|
|
3036
|
+
credit_utilization?: number;
|
|
2479
3037
|
}
|
|
2480
3038
|
|
|
2481
3039
|
/**
|
|
2482
3040
|
* Generated by orval v7.21.0 🍺
|
|
2483
3041
|
* Do not edit manually.
|
|
2484
3042
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
3043
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2486
3044
|
|
|
2487
|
-
**Published:** 2026-
|
|
2488
|
-
* OpenAPI spec version: 2026.
|
|
3045
|
+
**Published:** 2026-10-30
|
|
3046
|
+
* OpenAPI spec version: 2026.21.0
|
|
2489
3047
|
*/
|
|
2490
3048
|
|
|
2491
3049
|
/**
|
|
2492
3050
|
* Response containing the DocuSign envelope ID and embedded signing URL
|
|
2493
3051
|
*/
|
|
2494
3052
|
interface DraResponse {
|
|
3053
|
+
/** Applicant signing details */
|
|
2495
3054
|
applicant?: DraApplicant;
|
|
2496
3055
|
/** DocuSign envelope ID for this signing session */
|
|
2497
3056
|
envelopeId?: string;
|
|
@@ -2501,10 +3060,10 @@ interface DraResponse {
|
|
|
2501
3060
|
* Generated by orval v7.21.0 🍺
|
|
2502
3061
|
* Do not edit manually.
|
|
2503
3062
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
3063
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2505
3064
|
|
|
2506
|
-
**Published:** 2026-
|
|
2507
|
-
* OpenAPI spec version: 2026.
|
|
3065
|
+
**Published:** 2026-10-30
|
|
3066
|
+
* OpenAPI spec version: 2026.21.0
|
|
2508
3067
|
*/
|
|
2509
3068
|
/**
|
|
2510
3069
|
* Address for eligibility request
|
|
@@ -2526,10 +3085,27 @@ interface EligibilityAddress {
|
|
|
2526
3085
|
* Generated by orval v7.21.0 🍺
|
|
2527
3086
|
* Do not edit manually.
|
|
2528
3087
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
3088
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3089
|
+
|
|
3090
|
+
**Published:** 2026-10-30
|
|
3091
|
+
* OpenAPI spec version: 2026.21.0
|
|
3092
|
+
*/
|
|
3093
|
+
|
|
3094
|
+
/**
|
|
3095
|
+
* Required when pull_credit_report is true. Records the applicant's consent to a soft credit pull.
|
|
3096
|
+
|
|
3097
|
+
⚠️ Patched locally by `openapi/repairs.ts` — this differs from FDR's published spec.
|
|
3098
|
+
*/
|
|
3099
|
+
type EligibilityApplicantCreditPullConsent = CreditPullConsent | null;
|
|
3100
|
+
|
|
3101
|
+
/**
|
|
3102
|
+
* Generated by orval v7.21.0 🍺
|
|
3103
|
+
* Do not edit manually.
|
|
3104
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
3105
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2530
3106
|
|
|
2531
|
-
**Published:** 2026-
|
|
2532
|
-
* OpenAPI spec version: 2026.
|
|
3107
|
+
**Published:** 2026-10-30
|
|
3108
|
+
* OpenAPI spec version: 2026.21.0
|
|
2533
3109
|
*/
|
|
2534
3110
|
|
|
2535
3111
|
/**
|
|
@@ -2546,35 +3122,72 @@ interface EligibilityApplicant {
|
|
|
2546
3122
|
evening_phone_number?: string;
|
|
2547
3123
|
/** Date of birth (YYYY-MM-DD) */
|
|
2548
3124
|
date_of_birth?: string;
|
|
3125
|
+
/** Applicant Social Security number accepted for the credit-pull mode. Example is a dummy placeholder, not a valid SSN. */
|
|
3126
|
+
social_security_number?: string;
|
|
3127
|
+
/** Current address. Only state required for non-PII quote. */
|
|
2549
3128
|
current_address?: EligibilityAddress;
|
|
3129
|
+
/** Mailing address (optional) */
|
|
2550
3130
|
mailing_address?: EligibilityAddress;
|
|
2551
|
-
|
|
3131
|
+
/** Required when pull_credit_report is true. Records the applicant's consent to a soft credit pull.
|
|
3132
|
+
|
|
3133
|
+
⚠️ Patched locally by `openapi/repairs.ts` — this differs from FDR's published spec. */
|
|
3134
|
+
credit_pull_consent?: EligibilityApplicantCreditPullConsent;
|
|
2552
3135
|
}
|
|
2553
3136
|
|
|
2554
3137
|
/**
|
|
2555
3138
|
* Generated by orval v7.21.0 🍺
|
|
2556
3139
|
* Do not edit manually.
|
|
2557
3140
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
3141
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3142
|
+
|
|
3143
|
+
**Published:** 2026-10-30
|
|
3144
|
+
* OpenAPI spec version: 2026.21.0
|
|
3145
|
+
*/
|
|
3146
|
+
|
|
3147
|
+
/**
|
|
3148
|
+
* Program-level reasons the application is ineligible, if any. A successful HTTP 200 response does not imply program eligibility. See ProgramIneligibilityReasonCode for known returned values; additional values may be returned.
|
|
3149
|
+
*/
|
|
3150
|
+
type EligibilityApplicationIneligibleReason = ProgramIneligibilityReason[] | null;
|
|
3151
|
+
|
|
3152
|
+
/**
|
|
3153
|
+
* Generated by orval v7.21.0 🍺
|
|
3154
|
+
* Do not edit manually.
|
|
3155
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
3156
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3157
|
+
|
|
3158
|
+
**Published:** 2026-10-30
|
|
3159
|
+
* OpenAPI spec version: 2026.21.0
|
|
3160
|
+
*/
|
|
3161
|
+
|
|
3162
|
+
/**
|
|
3163
|
+
* 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.
|
|
3164
|
+
*/
|
|
3165
|
+
type EligibilityApplicationPaymentScheduleOptions = PaymentScheduleOption[] | null;
|
|
3166
|
+
|
|
3167
|
+
/**
|
|
3168
|
+
* Generated by orval v7.21.0 🍺
|
|
3169
|
+
* Do not edit manually.
|
|
3170
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
3171
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2559
3172
|
|
|
2560
|
-
**Published:** 2026-
|
|
2561
|
-
* OpenAPI spec version: 2026.
|
|
3173
|
+
**Published:** 2026-10-30
|
|
3174
|
+
* OpenAPI spec version: 2026.21.0
|
|
2562
3175
|
*/
|
|
2563
3176
|
|
|
2564
3177
|
/**
|
|
2565
3178
|
* Program data returned by the eligibility endpoint. A focused subset of the full lead application object.
|
|
2566
3179
|
*/
|
|
2567
3180
|
interface EligibilityApplication {
|
|
3181
|
+
/** Applicant details including eligibility token */
|
|
2568
3182
|
applicant?: LeadApplicant;
|
|
2569
3183
|
/** Debt accounts used in the eligibility calculation */
|
|
2570
3184
|
debt_accounts?: LeadDebtAccount[];
|
|
3185
|
+
/** Program-level reasons the application is ineligible, if any. A successful HTTP 200 response does not imply program eligibility. See ProgramIneligibilityReasonCode for known returned values; additional values may be returned. */
|
|
3186
|
+
ineligible_reason?: EligibilityApplicationIneligibleReason;
|
|
2571
3187
|
/** Selectable payment options (3 tiers) */
|
|
2572
3188
|
payment_options?: PaymentOption[];
|
|
2573
|
-
/**
|
|
2574
|
-
|
|
2575
|
-
* @nullable
|
|
2576
|
-
*/
|
|
2577
|
-
payment_schedule_options?: PaymentScheduleOption[] | null;
|
|
3189
|
+
/** 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. */
|
|
3190
|
+
payment_schedule_options?: EligibilityApplicationPaymentScheduleOptions;
|
|
2578
3191
|
/** Total enrolled debt (USD) */
|
|
2579
3192
|
estimated_total_debt?: number;
|
|
2580
3193
|
/** Total cost if no action taken (USD) */
|
|
@@ -2641,16 +3254,44 @@ interface EligibilityApplication {
|
|
|
2641
3254
|
* Generated by orval v7.21.0 🍺
|
|
2642
3255
|
* Do not edit manually.
|
|
2643
3256
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
3257
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3258
|
+
|
|
3259
|
+
**Published:** 2026-10-30
|
|
3260
|
+
* OpenAPI spec version: 2026.21.0
|
|
3261
|
+
*/
|
|
3262
|
+
/**
|
|
3263
|
+
* Alternative creditor name when creditor is not in the standard list
|
|
3264
|
+
*/
|
|
3265
|
+
type EligibilityDebtAccountCurrentCreditorOther = string | null;
|
|
3266
|
+
|
|
3267
|
+
/**
|
|
3268
|
+
* Generated by orval v7.21.0 🍺
|
|
3269
|
+
* Do not edit manually.
|
|
3270
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
3271
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3272
|
+
|
|
3273
|
+
**Published:** 2026-10-30
|
|
3274
|
+
* OpenAPI spec version: 2026.21.0
|
|
3275
|
+
*/
|
|
3276
|
+
/**
|
|
3277
|
+
* Condition of the account
|
|
3278
|
+
*/
|
|
3279
|
+
type EligibilityDebtAccountAccountCondition = string | null;
|
|
3280
|
+
|
|
3281
|
+
/**
|
|
3282
|
+
* Generated by orval v7.21.0 🍺
|
|
3283
|
+
* Do not edit manually.
|
|
3284
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
3285
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2645
3286
|
|
|
2646
|
-
**Published:** 2026-
|
|
2647
|
-
* OpenAPI spec version: 2026.
|
|
3287
|
+
**Published:** 2026-10-30
|
|
3288
|
+
* OpenAPI spec version: 2026.21.0
|
|
2648
3289
|
*/
|
|
3290
|
+
|
|
2649
3291
|
/**
|
|
2650
3292
|
* Debt account entry for eligibility check (no-credit-pull path)
|
|
2651
|
-
* @nullable
|
|
2652
3293
|
*/
|
|
2653
|
-
|
|
3294
|
+
interface EligibilityDebtAccount {
|
|
2654
3295
|
/** Origin of this debt account record */
|
|
2655
3296
|
source?: string;
|
|
2656
3297
|
/** Seller-assigned reference ID */
|
|
@@ -2661,32 +3302,41 @@ type EligibilityDebtAccount = {
|
|
|
2661
3302
|
estimated_debt?: number;
|
|
2662
3303
|
/** Current minimum monthly payment */
|
|
2663
3304
|
current_monthly_payment?: number;
|
|
2664
|
-
/**
|
|
2665
|
-
|
|
2666
|
-
* @nullable
|
|
2667
|
-
*/
|
|
2668
|
-
current_creditor_other?: string | null;
|
|
3305
|
+
/** Alternative creditor name when creditor is not in the standard list */
|
|
3306
|
+
current_creditor_other?: EligibilityDebtAccountCurrentCreditorOther;
|
|
2669
3307
|
/** Creditor name */
|
|
2670
3308
|
creditor_name?: string;
|
|
2671
3309
|
/** Account type */
|
|
2672
3310
|
account_type?: string;
|
|
2673
3311
|
/** Last 4 digits or masked account number */
|
|
2674
3312
|
account_number?: string;
|
|
2675
|
-
/**
|
|
2676
|
-
|
|
2677
|
-
|
|
2678
|
-
|
|
2679
|
-
|
|
2680
|
-
|
|
3313
|
+
/** Condition of the account */
|
|
3314
|
+
account_condition?: EligibilityDebtAccountAccountCondition;
|
|
3315
|
+
}
|
|
3316
|
+
|
|
3317
|
+
/**
|
|
3318
|
+
* Generated by orval v7.21.0 🍺
|
|
3319
|
+
* Do not edit manually.
|
|
3320
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
3321
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3322
|
+
|
|
3323
|
+
**Published:** 2026-10-30
|
|
3324
|
+
* OpenAPI spec version: 2026.21.0
|
|
3325
|
+
*/
|
|
3326
|
+
|
|
3327
|
+
/**
|
|
3328
|
+
* Debt accounts to evaluate. Required when pull_credit_report is false.
|
|
3329
|
+
*/
|
|
3330
|
+
type EligibilityRequestDebtAccounts = EligibilityDebtAccount[] | null;
|
|
2681
3331
|
|
|
2682
3332
|
/**
|
|
2683
3333
|
* Generated by orval v7.21.0 🍺
|
|
2684
3334
|
* Do not edit manually.
|
|
2685
3335
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
3336
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2687
3337
|
|
|
2688
|
-
**Published:** 2026-
|
|
2689
|
-
* OpenAPI spec version: 2026.
|
|
3338
|
+
**Published:** 2026-10-30
|
|
3339
|
+
* OpenAPI spec version: 2026.21.0
|
|
2690
3340
|
*/
|
|
2691
3341
|
|
|
2692
3342
|
/**
|
|
@@ -2695,22 +3345,20 @@ type EligibilityDebtAccount = {
|
|
|
2695
3345
|
interface EligibilityRequest {
|
|
2696
3346
|
/** Whether to pull a live soft credit report. When false, debt_accounts must be provided instead. */
|
|
2697
3347
|
pull_credit_report: boolean;
|
|
3348
|
+
/** Applicant details. Only state is required when pull_credit_report is false. */
|
|
2698
3349
|
applicant?: EligibilityApplicant;
|
|
2699
|
-
/**
|
|
2700
|
-
|
|
2701
|
-
* @nullable
|
|
2702
|
-
*/
|
|
2703
|
-
debt_accounts?: EligibilityDebtAccount[] | null;
|
|
3350
|
+
/** Debt accounts to evaluate. Required when pull_credit_report is false. */
|
|
3351
|
+
debt_accounts?: EligibilityRequestDebtAccounts;
|
|
2704
3352
|
}
|
|
2705
3353
|
|
|
2706
3354
|
/**
|
|
2707
3355
|
* Generated by orval v7.21.0 🍺
|
|
2708
3356
|
* Do not edit manually.
|
|
2709
3357
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
3358
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2711
3359
|
|
|
2712
|
-
**Published:** 2026-
|
|
2713
|
-
* OpenAPI spec version: 2026.
|
|
3360
|
+
**Published:** 2026-10-30
|
|
3361
|
+
* OpenAPI spec version: 2026.21.0
|
|
2714
3362
|
*/
|
|
2715
3363
|
|
|
2716
3364
|
/**
|
|
@@ -2721,6 +3369,7 @@ interface EligibilityResponse {
|
|
|
2721
3369
|
id?: string;
|
|
2722
3370
|
/** Result message */
|
|
2723
3371
|
message?: string;
|
|
3372
|
+
/** Eligibility program data */
|
|
2724
3373
|
application?: EligibilityApplication;
|
|
2725
3374
|
}
|
|
2726
3375
|
|
|
@@ -2728,10 +3377,42 @@ interface EligibilityResponse {
|
|
|
2728
3377
|
* Generated by orval v7.21.0 🍺
|
|
2729
3378
|
* Do not edit manually.
|
|
2730
3379
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
3380
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3381
|
+
|
|
3382
|
+
**Published:** 2026-10-30
|
|
3383
|
+
* OpenAPI spec version: 2026.21.0
|
|
3384
|
+
*/
|
|
3385
|
+
/**
|
|
3386
|
+
* Field-projected flat record; shape depends on the ?query= parameter
|
|
3387
|
+
*/
|
|
3388
|
+
type GetApplicationStatus200 = {
|
|
3389
|
+
[key: string]: unknown;
|
|
3390
|
+
};
|
|
3391
|
+
|
|
3392
|
+
/**
|
|
3393
|
+
* Generated by orval v7.21.0 🍺
|
|
3394
|
+
* Do not edit manually.
|
|
3395
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
3396
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3397
|
+
|
|
3398
|
+
**Published:** 2026-10-30
|
|
3399
|
+
* OpenAPI spec version: 2026.21.0
|
|
3400
|
+
*/
|
|
3401
|
+
type GetApplicationStatusParams = {
|
|
3402
|
+
/**
|
|
3403
|
+
* Comma-separated list of field names to project. Omit or leave blank to use the default projection.
|
|
3404
|
+
*/
|
|
3405
|
+
query?: string;
|
|
3406
|
+
};
|
|
3407
|
+
|
|
3408
|
+
/**
|
|
3409
|
+
* Generated by orval v7.21.0 🍺
|
|
3410
|
+
* Do not edit manually.
|
|
3411
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
3412
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2732
3413
|
|
|
2733
|
-
**Published:** 2026-
|
|
2734
|
-
* OpenAPI spec version: 2026.
|
|
3414
|
+
**Published:** 2026-10-30
|
|
3415
|
+
* OpenAPI spec version: 2026.21.0
|
|
2735
3416
|
*/
|
|
2736
3417
|
/**
|
|
2737
3418
|
* Address — used for current and mailing address updates
|
|
@@ -2753,10 +3434,10 @@ interface PatchAddress {
|
|
|
2753
3434
|
* Generated by orval v7.21.0 🍺
|
|
2754
3435
|
* Do not edit manually.
|
|
2755
3436
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
3437
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2757
3438
|
|
|
2758
|
-
**Published:** 2026-
|
|
2759
|
-
* OpenAPI spec version: 2026.
|
|
3439
|
+
**Published:** 2026-10-30
|
|
3440
|
+
* OpenAPI spec version: 2026.21.0
|
|
2760
3441
|
*/
|
|
2761
3442
|
|
|
2762
3443
|
/**
|
|
@@ -2779,7 +3460,9 @@ interface PatchApplicant {
|
|
|
2779
3460
|
mobile_phone_number?: string;
|
|
2780
3461
|
/** Applicant email address */
|
|
2781
3462
|
email?: string;
|
|
3463
|
+
/** Current residential address */
|
|
2782
3464
|
current_address?: PatchAddress;
|
|
3465
|
+
/** Mailing address (if different from current) */
|
|
2783
3466
|
mailing_address?: PatchAddress;
|
|
2784
3467
|
/** FDR applicant identifier */
|
|
2785
3468
|
fdr_applicant_id?: string;
|
|
@@ -2825,10 +3508,29 @@ interface PatchApplicant {
|
|
|
2825
3508
|
* Generated by orval v7.21.0 🍺
|
|
2826
3509
|
* Do not edit manually.
|
|
2827
3510
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
3511
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3512
|
+
|
|
3513
|
+
**Published:** 2026-10-30
|
|
3514
|
+
* OpenAPI spec version: 2026.21.0
|
|
3515
|
+
*/
|
|
3516
|
+
/**
|
|
3517
|
+
* Draft frequency for the application
|
|
3518
|
+
*/
|
|
3519
|
+
type LeadPatchRequestDraftType = typeof LeadPatchRequestDraftType[keyof typeof LeadPatchRequestDraftType];
|
|
3520
|
+
declare const LeadPatchRequestDraftType: {
|
|
3521
|
+
readonly regular: "regular";
|
|
3522
|
+
readonly split: "split";
|
|
3523
|
+
readonly 'bi-weekly': "bi-weekly";
|
|
3524
|
+
};
|
|
3525
|
+
|
|
3526
|
+
/**
|
|
3527
|
+
* Generated by orval v7.21.0 🍺
|
|
3528
|
+
* Do not edit manually.
|
|
3529
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
3530
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2829
3531
|
|
|
2830
|
-
**Published:** 2026-
|
|
2831
|
-
* OpenAPI spec version: 2026.
|
|
3532
|
+
**Published:** 2026-10-30
|
|
3533
|
+
* OpenAPI spec version: 2026.21.0
|
|
2832
3534
|
*/
|
|
2833
3535
|
/**
|
|
2834
3536
|
* Hardship category
|
|
@@ -2847,10 +3549,10 @@ declare const LeadPatchRequestHardshipCategory: {
|
|
|
2847
3549
|
* Generated by orval v7.21.0 🍺
|
|
2848
3550
|
* Do not edit manually.
|
|
2849
3551
|
* 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.
|
|
3552
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2851
3553
|
|
|
2852
|
-
**Published:** 2026-
|
|
2853
|
-
* OpenAPI spec version: 2026.
|
|
3554
|
+
**Published:** 2026-10-30
|
|
3555
|
+
* OpenAPI spec version: 2026.21.0
|
|
2854
3556
|
*/
|
|
2855
3557
|
/**
|
|
2856
3558
|
* Goal category
|
|
@@ -2867,10 +3569,10 @@ declare const LeadPatchRequestGoalCategory: {
|
|
|
2867
3569
|
* Generated by orval v7.21.0 🍺
|
|
2868
3570
|
* Do not edit manually.
|
|
2869
3571
|
* 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.
|
|
3572
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2871
3573
|
|
|
2872
|
-
**Published:** 2026-
|
|
2873
|
-
* OpenAPI spec version: 2026.
|
|
3574
|
+
**Published:** 2026-10-30
|
|
3575
|
+
* OpenAPI spec version: 2026.21.0
|
|
2874
3576
|
*/
|
|
2875
3577
|
/**
|
|
2876
3578
|
* Condition to verify (lead-level or debt-account-level)
|
|
@@ -2888,10 +3590,10 @@ interface PatchCondition {
|
|
|
2888
3590
|
* Generated by orval v7.21.0 🍺
|
|
2889
3591
|
* Do not edit manually.
|
|
2890
3592
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
3593
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2892
3594
|
|
|
2893
|
-
**Published:** 2026-
|
|
2894
|
-
* OpenAPI spec version: 2026.
|
|
3595
|
+
**Published:** 2026-10-30
|
|
3596
|
+
* OpenAPI spec version: 2026.21.0
|
|
2895
3597
|
*/
|
|
2896
3598
|
|
|
2897
3599
|
/**
|
|
@@ -2912,10 +3614,10 @@ interface PatchDebtAccount {
|
|
|
2912
3614
|
* Generated by orval v7.21.0 🍺
|
|
2913
3615
|
* Do not edit manually.
|
|
2914
3616
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
3617
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2916
3618
|
|
|
2917
|
-
**Published:** 2026-
|
|
2918
|
-
* OpenAPI spec version: 2026.
|
|
3619
|
+
**Published:** 2026-10-30
|
|
3620
|
+
* OpenAPI spec version: 2026.21.0
|
|
2919
3621
|
*/
|
|
2920
3622
|
/**
|
|
2921
3623
|
* Co-applicant fields that can be patched
|
|
@@ -2973,16 +3675,17 @@ interface PatchCoApplicant {
|
|
|
2973
3675
|
* Generated by orval v7.21.0 🍺
|
|
2974
3676
|
* Do not edit manually.
|
|
2975
3677
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
3678
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2977
3679
|
|
|
2978
|
-
**Published:** 2026-
|
|
2979
|
-
* OpenAPI spec version: 2026.
|
|
3680
|
+
**Published:** 2026-10-30
|
|
3681
|
+
* OpenAPI spec version: 2026.21.0
|
|
2980
3682
|
*/
|
|
2981
3683
|
|
|
2982
3684
|
/**
|
|
2983
|
-
* Partial update request for an existing application / lead record. Only provided fields are updated.
|
|
3685
|
+
* Partial update request for an existing application / lead record. Only provided fields are updated. During underwriter submission and approval, first_draft_date defaults to the applicant's next_pay_date. To use a different first draft date, patch it after UW approval.
|
|
2984
3686
|
*/
|
|
2985
3687
|
interface LeadPatchRequest {
|
|
3688
|
+
/** Applicant fields to update */
|
|
2986
3689
|
applicant?: PatchApplicant;
|
|
2987
3690
|
/** Whether the applicant owns or rents their home */
|
|
2988
3691
|
own_or_rent?: string;
|
|
@@ -2990,6 +3693,10 @@ interface LeadPatchRequest {
|
|
|
2990
3693
|
rent_or_mortgage_monthly?: number;
|
|
2991
3694
|
/** Desired monthly deposit amount */
|
|
2992
3695
|
monthly_deposit?: number;
|
|
3696
|
+
/** Draft frequency for the application */
|
|
3697
|
+
draft_type?: LeadPatchRequestDraftType;
|
|
3698
|
+
/** First draft date (YYYY-MM-DD). Defaults to applicant.next_pay_date during UW submission and approval. Patch after UW approval to use a different date. */
|
|
3699
|
+
first_draft_date?: string;
|
|
2993
3700
|
/** 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
3701
|
second_draft_date_split?: string;
|
|
2995
3702
|
/** Hardship category */
|
|
@@ -3070,6 +3777,7 @@ interface LeadPatchRequest {
|
|
|
3070
3777
|
conditions?: PatchCondition[];
|
|
3071
3778
|
/** Debt accounts with condition updates */
|
|
3072
3779
|
debt_accounts?: PatchDebtAccount[];
|
|
3780
|
+
/** Co-applicant fields to update */
|
|
3073
3781
|
co_applicant?: PatchCoApplicant;
|
|
3074
3782
|
}
|
|
3075
3783
|
|
|
@@ -3077,39 +3785,77 @@ interface LeadPatchRequest {
|
|
|
3077
3785
|
* Generated by orval v7.21.0 🍺
|
|
3078
3786
|
* Do not edit manually.
|
|
3079
3787
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
3788
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3789
|
+
|
|
3790
|
+
**Published:** 2026-10-30
|
|
3791
|
+
* OpenAPI spec version: 2026.21.0
|
|
3792
|
+
*/
|
|
3793
|
+
/**
|
|
3794
|
+
* Whether a program refresh was required before UW submission could proceed
|
|
3795
|
+
*/
|
|
3796
|
+
type LeadReadinessIsProgramRefreshRequired = boolean | null;
|
|
3797
|
+
|
|
3798
|
+
/**
|
|
3799
|
+
* Generated by orval v7.21.0 🍺
|
|
3800
|
+
* Do not edit manually.
|
|
3801
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
3802
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3803
|
+
|
|
3804
|
+
**Published:** 2026-10-30
|
|
3805
|
+
* OpenAPI spec version: 2026.21.0
|
|
3806
|
+
*/
|
|
3807
|
+
/**
|
|
3808
|
+
* Whether UW has previously approved this application
|
|
3809
|
+
*/
|
|
3810
|
+
type LeadReadinessIsUwApproved = boolean | null;
|
|
3811
|
+
|
|
3812
|
+
/**
|
|
3813
|
+
* Generated by orval v7.21.0 🍺
|
|
3814
|
+
* Do not edit manually.
|
|
3815
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
3816
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3081
3817
|
|
|
3082
|
-
**Published:** 2026-
|
|
3083
|
-
* OpenAPI spec version: 2026.
|
|
3818
|
+
**Published:** 2026-10-30
|
|
3819
|
+
* OpenAPI spec version: 2026.21.0
|
|
3084
3820
|
*/
|
|
3085
3821
|
|
|
3086
3822
|
/**
|
|
3087
3823
|
* Program readiness evaluation result (UW Submission response only)
|
|
3088
|
-
* @nullable
|
|
3089
3824
|
*/
|
|
3090
|
-
|
|
3825
|
+
interface LeadReadiness {
|
|
3091
3826
|
/** Array of readiness check results */
|
|
3092
3827
|
checks?: Check[];
|
|
3093
|
-
/**
|
|
3094
|
-
|
|
3095
|
-
|
|
3096
|
-
|
|
3097
|
-
|
|
3098
|
-
|
|
3099
|
-
|
|
3100
|
-
|
|
3101
|
-
|
|
3102
|
-
|
|
3103
|
-
|
|
3828
|
+
/** Whether a program refresh was required before UW submission could proceed */
|
|
3829
|
+
is_program_refresh_required?: LeadReadinessIsProgramRefreshRequired;
|
|
3830
|
+
/** Whether UW has previously approved this application */
|
|
3831
|
+
is_uw_approved?: LeadReadinessIsUwApproved;
|
|
3832
|
+
}
|
|
3833
|
+
|
|
3834
|
+
/**
|
|
3835
|
+
* Generated by orval v7.21.0 🍺
|
|
3836
|
+
* Do not edit manually.
|
|
3837
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
3838
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3839
|
+
|
|
3840
|
+
**Published:** 2026-10-30
|
|
3841
|
+
* OpenAPI spec version: 2026.21.0
|
|
3842
|
+
*/
|
|
3843
|
+
|
|
3844
|
+
/**
|
|
3845
|
+
* Readiness check result. Present ONLY in UW Submission responses; absent from GET Lead and PATCH Lead responses.
|
|
3846
|
+
|
|
3847
|
+
⚠️ Patched locally by `openapi/repairs.ts` — this differs from FDR's published spec.
|
|
3848
|
+
*/
|
|
3849
|
+
type LeadResponseReadiness = LeadReadiness | null;
|
|
3104
3850
|
|
|
3105
3851
|
/**
|
|
3106
3852
|
* Generated by orval v7.21.0 🍺
|
|
3107
3853
|
* Do not edit manually.
|
|
3108
3854
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
3855
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3110
3856
|
|
|
3111
|
-
**Published:** 2026-
|
|
3112
|
-
* OpenAPI spec version: 2026.
|
|
3857
|
+
**Published:** 2026-10-30
|
|
3858
|
+
* OpenAPI spec version: 2026.21.0
|
|
3113
3859
|
*/
|
|
3114
3860
|
|
|
3115
3861
|
/**
|
|
@@ -3120,18 +3866,22 @@ interface LeadResponse {
|
|
|
3120
3866
|
id?: string;
|
|
3121
3867
|
/** Result message */
|
|
3122
3868
|
message?: string;
|
|
3869
|
+
/** Transformed program data */
|
|
3123
3870
|
application?: LeadApplication;
|
|
3124
|
-
|
|
3871
|
+
/** Readiness check result. Present ONLY in UW Submission responses; absent from GET Lead and PATCH Lead responses.
|
|
3872
|
+
|
|
3873
|
+
⚠️ Patched locally by `openapi/repairs.ts` — this differs from FDR's published spec. */
|
|
3874
|
+
readiness?: LeadResponseReadiness;
|
|
3125
3875
|
}
|
|
3126
3876
|
|
|
3127
3877
|
/**
|
|
3128
3878
|
* Generated by orval v7.21.0 🍺
|
|
3129
3879
|
* Do not edit manually.
|
|
3130
3880
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
3881
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3132
3882
|
|
|
3133
|
-
**Published:** 2026-
|
|
3134
|
-
* OpenAPI spec version: 2026.
|
|
3883
|
+
**Published:** 2026-10-30
|
|
3884
|
+
* OpenAPI spec version: 2026.21.0
|
|
3135
3885
|
*/
|
|
3136
3886
|
/**
|
|
3137
3887
|
* Applicant mailing address.
|
|
@@ -3151,10 +3901,10 @@ interface MailingAddress {
|
|
|
3151
3901
|
* Generated by orval v7.21.0 🍺
|
|
3152
3902
|
* Do not edit manually.
|
|
3153
3903
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
3904
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3155
3905
|
|
|
3156
|
-
**Published:** 2026-
|
|
3157
|
-
* OpenAPI spec version: 2026.
|
|
3906
|
+
**Published:** 2026-10-30
|
|
3907
|
+
* OpenAPI spec version: 2026.21.0
|
|
3158
3908
|
*/
|
|
3159
3909
|
/**
|
|
3160
3910
|
* Marketing tracking metadata
|
|
@@ -3172,10 +3922,10 @@ interface Tracking {
|
|
|
3172
3922
|
* Generated by orval v7.21.0 🍺
|
|
3173
3923
|
* Do not edit manually.
|
|
3174
3924
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
3925
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3176
3926
|
|
|
3177
|
-
**Published:** 2026-
|
|
3178
|
-
* OpenAPI spec version: 2026.
|
|
3927
|
+
**Published:** 2026-10-30
|
|
3928
|
+
* OpenAPI spec version: 2026.21.0
|
|
3179
3929
|
*/
|
|
3180
3930
|
|
|
3181
3931
|
/**
|
|
@@ -3198,8 +3948,11 @@ interface LeadTransferRequest {
|
|
|
3198
3948
|
unsecured_debt?: number;
|
|
3199
3949
|
/** Social Security Number in SSN format (e.g. 123-45-6789). Optional. */
|
|
3200
3950
|
social_security_number?: string;
|
|
3951
|
+
/** Applicant mailing address */
|
|
3201
3952
|
mailing_address?: MailingAddress;
|
|
3953
|
+
/** Marketing and tracking metadata */
|
|
3202
3954
|
tracking?: Tracking;
|
|
3955
|
+
/** Regulatory and platform consent strings */
|
|
3203
3956
|
consents?: Consents;
|
|
3204
3957
|
}
|
|
3205
3958
|
|
|
@@ -3207,10 +3960,52 @@ interface LeadTransferRequest {
|
|
|
3207
3960
|
* Generated by orval v7.21.0 🍺
|
|
3208
3961
|
* Do not edit manually.
|
|
3209
3962
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
3963
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3964
|
+
|
|
3965
|
+
**Published:** 2026-10-30
|
|
3966
|
+
* OpenAPI spec version: 2026.21.0
|
|
3967
|
+
*/
|
|
3968
|
+
/**
|
|
3969
|
+
* Evaluation identifier. Present on accepted leads.
|
|
3970
|
+
*/
|
|
3971
|
+
type LeadTransferResponseId = number | null;
|
|
3972
|
+
|
|
3973
|
+
/**
|
|
3974
|
+
* Generated by orval v7.21.0 🍺
|
|
3975
|
+
* Do not edit manually.
|
|
3976
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
3977
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3978
|
+
|
|
3979
|
+
**Published:** 2026-10-30
|
|
3980
|
+
* OpenAPI spec version: 2026.21.0
|
|
3981
|
+
*/
|
|
3982
|
+
/**
|
|
3983
|
+
* ISO-8601 timestamp when the evaluation was created. Present on accepted leads.
|
|
3984
|
+
*/
|
|
3985
|
+
type LeadTransferResponseCreatedAt = string | null;
|
|
3986
|
+
|
|
3987
|
+
/**
|
|
3988
|
+
* Generated by orval v7.21.0 🍺
|
|
3989
|
+
* Do not edit manually.
|
|
3990
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
3991
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3992
|
+
|
|
3993
|
+
**Published:** 2026-10-30
|
|
3994
|
+
* OpenAPI spec version: 2026.21.0
|
|
3995
|
+
*/
|
|
3996
|
+
/**
|
|
3997
|
+
* ISO-8601 timestamp when the evaluation was last updated. Present on accepted leads.
|
|
3998
|
+
*/
|
|
3999
|
+
type LeadTransferResponseUpdatedAt = string | null;
|
|
4000
|
+
|
|
4001
|
+
/**
|
|
4002
|
+
* Generated by orval v7.21.0 🍺
|
|
4003
|
+
* Do not edit manually.
|
|
4004
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
4005
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3211
4006
|
|
|
3212
|
-
**Published:** 2026-
|
|
3213
|
-
* OpenAPI spec version: 2026.
|
|
4007
|
+
**Published:** 2026-10-30
|
|
4008
|
+
* OpenAPI spec version: 2026.21.0
|
|
3214
4009
|
*/
|
|
3215
4010
|
/**
|
|
3216
4011
|
* Evaluation outcome: 'accepted' or 'rejected'.
|
|
@@ -3225,55 +4020,68 @@ declare const LeadTransferResponseResponse: {
|
|
|
3225
4020
|
* Generated by orval v7.21.0 🍺
|
|
3226
4021
|
* Do not edit manually.
|
|
3227
4022
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
4023
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
4024
|
+
|
|
4025
|
+
**Published:** 2026-10-30
|
|
4026
|
+
* OpenAPI spec version: 2026.21.0
|
|
4027
|
+
*/
|
|
4028
|
+
/**
|
|
4029
|
+
* Machine-readable reason for rejection. Present on rejected leads.
|
|
4030
|
+
*/
|
|
4031
|
+
type LeadTransferResponseResponseReason = string | null;
|
|
4032
|
+
|
|
4033
|
+
/**
|
|
4034
|
+
* Generated by orval v7.21.0 🍺
|
|
4035
|
+
* Do not edit manually.
|
|
4036
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
4037
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
4038
|
+
|
|
4039
|
+
**Published:** 2026-10-30
|
|
4040
|
+
* OpenAPI spec version: 2026.21.0
|
|
4041
|
+
*/
|
|
4042
|
+
/**
|
|
4043
|
+
* Human-readable rejection detail messages. Present on rejected leads. May be a plain string or an array of strings.
|
|
4044
|
+
*/
|
|
4045
|
+
type LeadTransferResponseResponseDetails = string[] | null;
|
|
4046
|
+
|
|
4047
|
+
/**
|
|
4048
|
+
* Generated by orval v7.21.0 🍺
|
|
4049
|
+
* Do not edit manually.
|
|
4050
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
4051
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3229
4052
|
|
|
3230
|
-
**Published:** 2026-
|
|
3231
|
-
* OpenAPI spec version: 2026.
|
|
4053
|
+
**Published:** 2026-10-30
|
|
4054
|
+
* OpenAPI spec version: 2026.21.0
|
|
3232
4055
|
*/
|
|
3233
4056
|
|
|
3234
4057
|
/**
|
|
3235
4058
|
* Lead evaluation result. Field presence varies between accepted and rejected outcomes.
|
|
3236
4059
|
*/
|
|
3237
4060
|
interface LeadTransferResponse {
|
|
3238
|
-
/**
|
|
3239
|
-
|
|
3240
|
-
|
|
3241
|
-
|
|
3242
|
-
|
|
3243
|
-
|
|
3244
|
-
* ISO-8601 timestamp when the evaluation was created. Present on accepted leads.
|
|
3245
|
-
* @nullable
|
|
3246
|
-
*/
|
|
3247
|
-
created_at?: string | null;
|
|
3248
|
-
/**
|
|
3249
|
-
* ISO-8601 timestamp when the evaluation was last updated. Present on accepted leads.
|
|
3250
|
-
* @nullable
|
|
3251
|
-
*/
|
|
3252
|
-
updated_at?: string | null;
|
|
4061
|
+
/** Evaluation identifier. Present on accepted leads. */
|
|
4062
|
+
id?: LeadTransferResponseId;
|
|
4063
|
+
/** ISO-8601 timestamp when the evaluation was created. Present on accepted leads. */
|
|
4064
|
+
created_at?: LeadTransferResponseCreatedAt;
|
|
4065
|
+
/** ISO-8601 timestamp when the evaluation was last updated. Present on accepted leads. */
|
|
4066
|
+
updated_at?: LeadTransferResponseUpdatedAt;
|
|
3253
4067
|
/** Evaluation outcome: 'accepted' or 'rejected'. */
|
|
3254
4068
|
response?: LeadTransferResponseResponse;
|
|
3255
4069
|
/** Redirect URL for the applicant to view offers. */
|
|
3256
4070
|
get_offers_url?: string;
|
|
3257
|
-
/**
|
|
3258
|
-
|
|
3259
|
-
|
|
3260
|
-
|
|
3261
|
-
response_reason?: string | null;
|
|
3262
|
-
/**
|
|
3263
|
-
* Human-readable rejection detail messages. Present on rejected leads. May be a plain string or an array of strings.
|
|
3264
|
-
* @nullable
|
|
3265
|
-
*/
|
|
3266
|
-
response_details?: (string | null)[] | null;
|
|
4071
|
+
/** Machine-readable reason for rejection. Present on rejected leads. */
|
|
4072
|
+
response_reason?: LeadTransferResponseResponseReason;
|
|
4073
|
+
/** Human-readable rejection detail messages. Present on rejected leads. May be a plain string or an array of strings. */
|
|
4074
|
+
response_details?: LeadTransferResponseResponseDetails;
|
|
3267
4075
|
}
|
|
3268
4076
|
|
|
3269
4077
|
/**
|
|
3270
4078
|
* Generated by orval v7.21.0 🍺
|
|
3271
4079
|
* Do not edit manually.
|
|
3272
4080
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
4081
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3274
4082
|
|
|
3275
|
-
**Published:** 2026-
|
|
3276
|
-
* OpenAPI spec version: 2026.
|
|
4083
|
+
**Published:** 2026-10-30
|
|
4084
|
+
* OpenAPI spec version: 2026.21.0
|
|
3277
4085
|
*/
|
|
3278
4086
|
/**
|
|
3279
4087
|
* Request body for async program generation (v1)
|
|
@@ -3289,10 +4097,10 @@ interface ProgramRequest {
|
|
|
3289
4097
|
* Generated by orval v7.21.0 🍺
|
|
3290
4098
|
* Do not edit manually.
|
|
3291
4099
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
4100
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3293
4101
|
|
|
3294
|
-
**Published:** 2026-
|
|
3295
|
-
* OpenAPI spec version: 2026.
|
|
4102
|
+
**Published:** 2026-10-30
|
|
4103
|
+
* OpenAPI spec version: 2026.21.0
|
|
3296
4104
|
*/
|
|
3297
4105
|
/**
|
|
3298
4106
|
* Minimal applicant reference identifying the lead
|
|
@@ -3308,10 +4116,10 @@ interface ProgramSelectionApplicant {
|
|
|
3308
4116
|
* Generated by orval v7.21.0 🍺
|
|
3309
4117
|
* Do not edit manually.
|
|
3310
4118
|
* 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.
|
|
4119
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3312
4120
|
|
|
3313
|
-
**Published:** 2026-
|
|
3314
|
-
* OpenAPI spec version: 2026.
|
|
4121
|
+
**Published:** 2026-10-30
|
|
4122
|
+
* OpenAPI spec version: 2026.21.0
|
|
3315
4123
|
*/
|
|
3316
4124
|
/**
|
|
3317
4125
|
* Selected draft schedule type from payment_schedule_options
|
|
@@ -3327,16 +4135,17 @@ declare const ProgramSelectionRequestDraftType: {
|
|
|
3327
4135
|
* Generated by orval v7.21.0 🍺
|
|
3328
4136
|
* Do not edit manually.
|
|
3329
4137
|
* 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.
|
|
4138
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3331
4139
|
|
|
3332
|
-
**Published:** 2026-
|
|
3333
|
-
* OpenAPI spec version: 2026.
|
|
4140
|
+
**Published:** 2026-10-30
|
|
4141
|
+
* OpenAPI spec version: 2026.21.0
|
|
3334
4142
|
*/
|
|
3335
4143
|
|
|
3336
4144
|
/**
|
|
3337
4145
|
* Request body for selecting a payment schedule for an existing lead
|
|
3338
4146
|
*/
|
|
3339
4147
|
interface ProgramSelectionRequest {
|
|
4148
|
+
/** Applicant reference identifying the lead to update */
|
|
3340
4149
|
applicant: ProgramSelectionApplicant;
|
|
3341
4150
|
/** Selected draft schedule type from payment_schedule_options */
|
|
3342
4151
|
draft_type?: ProgramSelectionRequestDraftType;
|
|
@@ -3348,10 +4157,10 @@ interface ProgramSelectionRequest {
|
|
|
3348
4157
|
* Generated by orval v7.21.0 🍺
|
|
3349
4158
|
* Do not edit manually.
|
|
3350
4159
|
* 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.
|
|
4160
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3352
4161
|
|
|
3353
|
-
**Published:** 2026-
|
|
3354
|
-
* OpenAPI spec version: 2026.
|
|
4162
|
+
**Published:** 2026-10-30
|
|
4163
|
+
* OpenAPI spec version: 2026.21.0
|
|
3355
4164
|
*/
|
|
3356
4165
|
/**
|
|
3357
4166
|
* Request body for creating a Program Summary Recording task (RWA-2427)
|
|
@@ -3375,10 +4184,10 @@ interface ProgramSummaryTaskRequest {
|
|
|
3375
4184
|
* Generated by orval v7.21.0 🍺
|
|
3376
4185
|
* Do not edit manually.
|
|
3377
4186
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
4187
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3379
4188
|
|
|
3380
|
-
**Published:** 2026-
|
|
3381
|
-
* OpenAPI spec version: 2026.
|
|
4189
|
+
**Published:** 2026-10-30
|
|
4190
|
+
* OpenAPI spec version: 2026.21.0
|
|
3382
4191
|
*/
|
|
3383
4192
|
/**
|
|
3384
4193
|
* Response body for a successfully created Program Summary Recording task
|
|
@@ -3402,10 +4211,38 @@ interface ProgramSummaryTaskResponse {
|
|
|
3402
4211
|
* Generated by orval v7.21.0 🍺
|
|
3403
4212
|
* Do not edit manually.
|
|
3404
4213
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
4214
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
4215
|
+
|
|
4216
|
+
**Published:** 2026-10-30
|
|
4217
|
+
* OpenAPI spec version: 2026.21.0
|
|
4218
|
+
*/
|
|
4219
|
+
/**
|
|
4220
|
+
* Whether a program refresh is required before proceeding
|
|
4221
|
+
*/
|
|
4222
|
+
type ReadinessResponseIsProgramRefreshRequired = boolean | null;
|
|
4223
|
+
|
|
4224
|
+
/**
|
|
4225
|
+
* Generated by orval v7.21.0 🍺
|
|
4226
|
+
* Do not edit manually.
|
|
4227
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
4228
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
4229
|
+
|
|
4230
|
+
**Published:** 2026-10-30
|
|
4231
|
+
* OpenAPI spec version: 2026.21.0
|
|
4232
|
+
*/
|
|
4233
|
+
/**
|
|
4234
|
+
* Whether UW has previously approved this application
|
|
4235
|
+
*/
|
|
4236
|
+
type ReadinessResponseIsUwApproved = boolean | null;
|
|
4237
|
+
|
|
4238
|
+
/**
|
|
4239
|
+
* Generated by orval v7.21.0 🍺
|
|
4240
|
+
* Do not edit manually.
|
|
4241
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
4242
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3406
4243
|
|
|
3407
|
-
**Published:** 2026-
|
|
3408
|
-
* OpenAPI spec version: 2026.
|
|
4244
|
+
**Published:** 2026-10-30
|
|
4245
|
+
* OpenAPI spec version: 2026.21.0
|
|
3409
4246
|
*/
|
|
3410
4247
|
|
|
3411
4248
|
/**
|
|
@@ -3414,26 +4251,20 @@ interface ProgramSummaryTaskResponse {
|
|
|
3414
4251
|
interface ReadinessResponse {
|
|
3415
4252
|
/** Array of individual readiness check results */
|
|
3416
4253
|
checks?: ReadinessCheck[];
|
|
3417
|
-
/**
|
|
3418
|
-
|
|
3419
|
-
|
|
3420
|
-
|
|
3421
|
-
is_program_refresh_required?: boolean | null;
|
|
3422
|
-
/**
|
|
3423
|
-
* Whether UW has previously approved this application
|
|
3424
|
-
* @nullable
|
|
3425
|
-
*/
|
|
3426
|
-
is_uw_approved?: boolean | null;
|
|
4254
|
+
/** Whether a program refresh is required before proceeding */
|
|
4255
|
+
is_program_refresh_required?: ReadinessResponseIsProgramRefreshRequired;
|
|
4256
|
+
/** Whether UW has previously approved this application */
|
|
4257
|
+
is_uw_approved?: ReadinessResponseIsUwApproved;
|
|
3427
4258
|
}
|
|
3428
4259
|
|
|
3429
4260
|
/**
|
|
3430
4261
|
* Generated by orval v7.21.0 🍺
|
|
3431
4262
|
* Do not edit manually.
|
|
3432
4263
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
4264
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3434
4265
|
|
|
3435
|
-
**Published:** 2026-
|
|
3436
|
-
* OpenAPI spec version: 2026.
|
|
4266
|
+
**Published:** 2026-10-30
|
|
4267
|
+
* OpenAPI spec version: 2026.21.0
|
|
3437
4268
|
*/
|
|
3438
4269
|
|
|
3439
4270
|
/**
|
|
@@ -3442,6 +4273,7 @@ interface ReadinessResponse {
|
|
|
3442
4273
|
interface RegisterApplicantV2Request {
|
|
3443
4274
|
/** Email of the seller agent to be set as the Salesforce record owner */
|
|
3444
4275
|
seller_agent_email?: string;
|
|
4276
|
+
/** Applicant details to register */
|
|
3445
4277
|
applicant: Applicant;
|
|
3446
4278
|
}
|
|
3447
4279
|
|
|
@@ -3449,10 +4281,10 @@ interface RegisterApplicantV2Request {
|
|
|
3449
4281
|
* Generated by orval v7.21.0 🍺
|
|
3450
4282
|
* Do not edit manually.
|
|
3451
4283
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
4284
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3453
4285
|
|
|
3454
|
-
**Published:** 2026-
|
|
3455
|
-
* OpenAPI spec version: 2026.
|
|
4286
|
+
**Published:** 2026-10-30
|
|
4287
|
+
* OpenAPI spec version: 2026.21.0
|
|
3456
4288
|
*/
|
|
3457
4289
|
/**
|
|
3458
4290
|
* Response returned after successfully registering an applicant via POST /v2/applicant/register
|
|
@@ -3472,10 +4304,10 @@ interface RegisterApplicantV2Response {
|
|
|
3472
4304
|
* Generated by orval v7.21.0 🍺
|
|
3473
4305
|
* Do not edit manually.
|
|
3474
4306
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
4307
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3476
4308
|
|
|
3477
|
-
**Published:** 2026-
|
|
3478
|
-
* OpenAPI spec version: 2026.
|
|
4309
|
+
**Published:** 2026-10-30
|
|
4310
|
+
* OpenAPI spec version: 2026.21.0
|
|
3479
4311
|
*/
|
|
3480
4312
|
|
|
3481
4313
|
/**
|
|
@@ -3492,6 +4324,7 @@ interface SpinwheelNetworkUserRequest {
|
|
|
3492
4324
|
network_user_token: string;
|
|
3493
4325
|
/** Applicant date of birth (ISO-8601) */
|
|
3494
4326
|
date_of_birth: string;
|
|
4327
|
+
/** Audit metadata including user consent date */
|
|
3495
4328
|
audit: AuditInfo;
|
|
3496
4329
|
}
|
|
3497
4330
|
|
|
@@ -3499,10 +4332,10 @@ interface SpinwheelNetworkUserRequest {
|
|
|
3499
4332
|
* Generated by orval v7.21.0 🍺
|
|
3500
4333
|
* Do not edit manually.
|
|
3501
4334
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
4335
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3503
4336
|
|
|
3504
|
-
**Published:** 2026-
|
|
3505
|
-
* OpenAPI spec version: 2026.
|
|
4337
|
+
**Published:** 2026-10-30
|
|
4338
|
+
* OpenAPI spec version: 2026.21.0
|
|
3506
4339
|
*/
|
|
3507
4340
|
/**
|
|
3508
4341
|
* Result of creating or connecting a Spinwheel network user
|
|
@@ -3518,10 +4351,10 @@ interface SpinwheelNetworkUserResponse {
|
|
|
3518
4351
|
* Generated by orval v7.21.0 🍺
|
|
3519
4352
|
* Do not edit manually.
|
|
3520
4353
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
4354
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3522
4355
|
|
|
3523
|
-
**Published:** 2026-
|
|
3524
|
-
* OpenAPI spec version: 2026.
|
|
4356
|
+
**Published:** 2026-10-30
|
|
4357
|
+
* OpenAPI spec version: 2026.21.0
|
|
3525
4358
|
*/
|
|
3526
4359
|
/**
|
|
3527
4360
|
* Primary hardship category
|
|
@@ -3540,10 +4373,10 @@ declare const StatelessReadinessRequestHardshipCategory: {
|
|
|
3540
4373
|
* Generated by orval v7.21.0 🍺
|
|
3541
4374
|
* Do not edit manually.
|
|
3542
4375
|
* 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.
|
|
4376
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3544
4377
|
|
|
3545
|
-
**Published:** 2026-
|
|
3546
|
-
* OpenAPI spec version: 2026.
|
|
4378
|
+
**Published:** 2026-10-30
|
|
4379
|
+
* OpenAPI spec version: 2026.21.0
|
|
3547
4380
|
*/
|
|
3548
4381
|
/**
|
|
3549
4382
|
* Primary goal category
|
|
@@ -3560,10 +4393,10 @@ declare const StatelessReadinessRequestGoalCategory: {
|
|
|
3560
4393
|
* Generated by orval v7.21.0 🍺
|
|
3561
4394
|
* Do not edit manually.
|
|
3562
4395
|
* 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.
|
|
4396
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3564
4397
|
|
|
3565
|
-
**Published:** 2026-
|
|
3566
|
-
* OpenAPI spec version: 2026.
|
|
4398
|
+
**Published:** 2026-10-30
|
|
4399
|
+
* OpenAPI spec version: 2026.21.0
|
|
3567
4400
|
*/
|
|
3568
4401
|
|
|
3569
4402
|
/**
|
|
@@ -3688,6 +4521,7 @@ interface StatelessReadinessRequest {
|
|
|
3688
4521
|
program_time_savings_vs_minimum_payments?: number;
|
|
3689
4522
|
/** Program payment options (3 tiers) */
|
|
3690
4523
|
payment_options?: PaymentOption[];
|
|
4524
|
+
/** Primary applicant details */
|
|
3691
4525
|
applicant?: LeadApplicantInput;
|
|
3692
4526
|
/** List of debt accounts submitted for readiness evaluation */
|
|
3693
4527
|
debt_accounts?: DebtAccount[];
|
|
@@ -3699,10 +4533,10 @@ interface StatelessReadinessRequest {
|
|
|
3699
4533
|
* Generated by orval v7.21.0 🍺
|
|
3700
4534
|
* Do not edit manually.
|
|
3701
4535
|
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
4536
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3703
4537
|
|
|
3704
|
-
**Published:** 2026-
|
|
3705
|
-
* OpenAPI spec version: 2026.
|
|
4538
|
+
**Published:** 2026-10-30
|
|
4539
|
+
* OpenAPI spec version: 2026.21.0
|
|
3706
4540
|
*/
|
|
3707
4541
|
/**
|
|
3708
4542
|
* Thin applicant projection returned within UW Submission V2
|
|
@@ -3728,10 +4562,10 @@ interface UwSubmissionV2Applicant {
|
|
|
3728
4562
|
* Generated by orval v7.21.0 🍺
|
|
3729
4563
|
* Do not edit manually.
|
|
3730
4564
|
* 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.
|
|
4565
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3732
4566
|
|
|
3733
|
-
**Published:** 2026-
|
|
3734
|
-
* OpenAPI spec version: 2026.
|
|
4567
|
+
**Published:** 2026-10-30
|
|
4568
|
+
* OpenAPI spec version: 2026.21.0
|
|
3735
4569
|
*/
|
|
3736
4570
|
|
|
3737
4571
|
/**
|
|
@@ -3740,6 +4574,7 @@ interface UwSubmissionV2Applicant {
|
|
|
3740
4574
|
interface UwSubmissionV2Application {
|
|
3741
4575
|
/** Application language */
|
|
3742
4576
|
language?: string;
|
|
4577
|
+
/** Applicant identity and contact projection */
|
|
3743
4578
|
applicant?: UwSubmissionV2Applicant;
|
|
3744
4579
|
/** Application conditions */
|
|
3745
4580
|
conditions?: LeadCondition[];
|
|
@@ -3771,10 +4606,24 @@ interface UwSubmissionV2Application {
|
|
|
3771
4606
|
* Generated by orval v7.21.0 🍺
|
|
3772
4607
|
* Do not edit manually.
|
|
3773
4608
|
* 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.
|
|
4609
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
4610
|
+
|
|
4611
|
+
**Published:** 2026-10-30
|
|
4612
|
+
* OpenAPI spec version: 2026.21.0
|
|
4613
|
+
*/
|
|
4614
|
+
/**
|
|
4615
|
+
* Human-readable outcome of the banking disclosure email step — success confirmation, suppression reason, or downstream failure cause. Omitted when sent successfully in some flows.
|
|
4616
|
+
*/
|
|
4617
|
+
type UwSubmissionV2ResponseBankingDisclosureEmailMessage = string | null;
|
|
4618
|
+
|
|
4619
|
+
/**
|
|
4620
|
+
* Generated by orval v7.21.0 🍺
|
|
4621
|
+
* Do not edit manually.
|
|
4622
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
4623
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3775
4624
|
|
|
3776
|
-
**Published:** 2026-
|
|
3777
|
-
* OpenAPI spec version: 2026.
|
|
4625
|
+
**Published:** 2026-10-30
|
|
4626
|
+
* OpenAPI spec version: 2026.21.0
|
|
3778
4627
|
*/
|
|
3779
4628
|
|
|
3780
4629
|
/**
|
|
@@ -3785,15 +4634,14 @@ interface UwSubmissionV2Response {
|
|
|
3785
4634
|
id?: string;
|
|
3786
4635
|
/** Result message */
|
|
3787
4636
|
message?: string;
|
|
4637
|
+
/** Thin application projection returned by UW Submission V2 */
|
|
3788
4638
|
application?: UwSubmissionV2Application;
|
|
4639
|
+
/** Readiness checks returned with the UW submission response */
|
|
3789
4640
|
readiness?: LeadReadiness;
|
|
3790
4641
|
/** 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). */
|
|
3791
4642
|
banking_disclosure_email_sent?: boolean;
|
|
3792
|
-
/**
|
|
3793
|
-
|
|
3794
|
-
* @nullable
|
|
3795
|
-
*/
|
|
3796
|
-
banking_disclosure_email_message?: string | null;
|
|
4643
|
+
/** Human-readable outcome of the banking disclosure email step — success confirmation, suppression reason, or downstream failure cause. Omitted when sent successfully in some flows. */
|
|
4644
|
+
banking_disclosure_email_message?: UwSubmissionV2ResponseBankingDisclosureEmailMessage;
|
|
3797
4645
|
}
|
|
3798
4646
|
|
|
3799
4647
|
/**
|
|
@@ -3810,9 +4658,8 @@ interface UwSubmissionV2Response {
|
|
|
3810
4658
|
* The two *vocabularies* remain — a corrected enum is not a unified one.
|
|
3811
4659
|
*
|
|
3812
4660
|
* Scope is narrow: `LeadApplication.draft_type` is the only label-valued site
|
|
3813
|
-
* in the whole spec. `
|
|
3814
|
-
*
|
|
3815
|
-
* `selectProgram` is the only write path.
|
|
4661
|
+
* in the whole spec. Every write path — `selectProgram`, and `patchLead` since
|
|
4662
|
+
* 2026.21.0 — takes the lowercase code, as does `PaymentSchedule`.
|
|
3816
4663
|
*
|
|
3817
4664
|
* These maps are annotated as `Record<>` over the generated enums on purpose:
|
|
3818
4665
|
* if FDR ever adds a fourth draft type, codegen widens the enum and these fail
|
|
@@ -3877,24 +4724,27 @@ declare const draftTypeOf: (application: LeadApplication | undefined | null) =>
|
|
|
3877
4724
|
declare class ArpcSDK {
|
|
3878
4725
|
/** The full typed endpoint surface — one method per gateway operation. */
|
|
3879
4726
|
readonly api: {
|
|
3880
|
-
|
|
3881
|
-
selectProgram: (programSelectionRequest: ProgramSelectionRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<LeadResponse>>;
|
|
3882
|
-
checkApplicationReadiness: (statelessReadinessRequest: StatelessReadinessRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<ReadinessResponse>>;
|
|
3883
|
-
createSpinwheelNetworkUser: (spinwheelNetworkUserRequest: SpinwheelNetworkUserRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<SpinwheelNetworkUserResponse>>;
|
|
3884
|
-
updateApplicationBankDetails: (applicantId: string, bankUpdateRequest: BankUpdateRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<LeadResponse>>;
|
|
4727
|
+
generateDra: (applicantId: string, draRequest: DraRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<DraResponse>>;
|
|
3885
4728
|
sendEmail: (fdrApplicantId: string, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<ApplicationSendEmailResponse>>;
|
|
3886
4729
|
leadTransfer: (leadTransferRequest: LeadTransferRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<LeadTransferResponse>>;
|
|
4730
|
+
createLeadSync: (createLeadRequest: CreateLeadRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<CreateLeadResponse>>;
|
|
3887
4731
|
readLead: (fdrApplicantId: string, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<LeadResponse>>;
|
|
3888
4732
|
patchLead: (fdrApplicantId: string, leadPatchRequest: LeadPatchRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<LeadResponse>>;
|
|
3889
|
-
|
|
3890
|
-
|
|
3891
|
-
registerApplicantV2: (registerApplicantV2Request: RegisterApplicantV2Request, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<RegisterApplicantV2Response>>;
|
|
4733
|
+
getApplicationStatus: (fdrApplicantId: string, params?: GetApplicationStatusParams, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<GetApplicationStatus200>>;
|
|
4734
|
+
selectProgram: (programSelectionRequest: ProgramSelectionRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<LeadResponse>>;
|
|
3892
4735
|
generateProgramV1: (programRequest: ProgramRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<LeadResponse>>;
|
|
3893
4736
|
checkEligibility: (eligibilityRequest: EligibilityRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<EligibilityResponse>>;
|
|
3894
|
-
|
|
4737
|
+
checkApplicationReadiness: (statelessReadinessRequest: StatelessReadinessRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<ReadinessResponse>>;
|
|
4738
|
+
getApplicationReadiness: (applicantId: string, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<ReadinessResponse>>;
|
|
4739
|
+
registerApplicantV2: (registerApplicantV2Request: RegisterApplicantV2Request, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<RegisterApplicantV2Response>>;
|
|
4740
|
+
createSpinwheelNetworkUser: (spinwheelNetworkUserRequest: SpinwheelNetworkUserRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<SpinwheelNetworkUserResponse>>;
|
|
4741
|
+
updateApplicationBankDetails: (applicantId: string, bankUpdateRequest: BankUpdateRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<LeadResponse>>;
|
|
3895
4742
|
createProgramSummaryTask: (id: string, programSummaryTaskRequest: ProgramSummaryTaskRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<ProgramSummaryTaskResponse>>;
|
|
4743
|
+
uwSubmissionV2: (fdrApplicantId: string, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<UwSubmissionV2Response>>;
|
|
4744
|
+
resendAgreement: (fdrApplicantId: string, envelopeId: string, agreementResendRequest: AgreementResendRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<DraResponse>>;
|
|
4745
|
+
voidAgreement: (fdrApplicantId: string, envelopeId: string, agreementVoidRequest: AgreementVoidRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<AgreementVoidResponse>>;
|
|
3896
4746
|
};
|
|
3897
4747
|
constructor(config: ArpcConfig);
|
|
3898
4748
|
}
|
|
3899
4749
|
|
|
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
|
|
4750
|
+
export { type ARPCErrorResponse, type ARPCErrorResponseErrorDetails, ARPC_ENDPOINTS, type Address, type AgreementErrorDetails, type AgreementErrorResponse, type AgreementResendApplicant, AgreementResendApplicantSigningType, type AgreementResendRequest, type AgreementVoidRequest, type AgreementVoidResponse, 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, type CheckErrorDetails, type CheckErrors, CheckType, type CoApplicant, type Consents, type CreateLeadRequest, type CreateLeadRequestDebtAccounts, CreateLeadRequestGoalCategory, CreateLeadRequestHardshipCategory, type CreateLeadResponse, type CreditPullConsent, DRAFT_TYPE_CODE, DRAFT_TYPE_LABEL, type DebtAccount, type DebtAccountIneligibilityReason, DebtAccountIneligibilityReasonReasonId, type DraApplicant, type DraApplicantInput, DraApplicantInputSigningType, type DraRequest, type DraResponse, type EligibilityAddress, type EligibilityApplicant, type EligibilityApplicantCreditPullConsent, type EligibilityApplication, type EligibilityApplicationIneligibleReason, type EligibilityApplicationPaymentScheduleOptions, type EligibilityDebtAccount, type EligibilityDebtAccountAccountCondition, type EligibilityDebtAccountCurrentCreditorOther, type EligibilityRequest, type EligibilityRequestDebtAccounts, type EligibilityResponse, type ErrorDetails, type ErrorDetailsMessage, type FieldValidationError, FieldValidationErrorReasonCode, type GetApplicationStatus200, type GetApplicationStatusParams, type HttpResponse, type LeadApplicant, LeadApplicantBankruptcy, type LeadApplicantConditions, LeadApplicantEmploymentStatus, type LeadApplicantInput, LeadApplicantPayFrequency, type LeadApplicantProgramEligibilityToken, type LeadApplication, type LeadApplicationBankDetails, type LeadApplicationCbrReportId, type LeadApplicationCoApplicant, type LeadApplicationCoApplicantCbrReportId, type LeadApplicationConditions, LeadApplicationCreditPullSource, type LeadApplicationDexFlowStatus, LeadApplicationDraftType, type LeadApplicationEligible, LeadApplicationFdrOrCss, LeadApplicationFixedIncome, LeadApplicationGoalCategory, type LeadApplicationGoalCategoryOther, LeadApplicationHardshipCategory, type LeadApplicationHardshipCategoryOther, type LeadApplicationIneligibleReason, LeadApplicationLanguage, type LeadApplicationLawFirmId, LeadApplicationOwnOrRent, type LeadApplicationPaymentOptions, type LeadApplicationPaymentScheduleOptions, LeadApplicationSecondaryGoal, LeadApplicationStatus, LeadApplicationSubStatus, type LeadCondition, LeadConditionActive, LeadConditionType, type LeadConditionVerified, type LeadConditionVerifiedByDebtConsultant, type LeadCreditor, type LeadDebtAccount, LeadDebtAccountAccountType, type LeadDebtAccountConditions, type LeadDebtAccountCurrentCreditorOther, type LeadDebtAccountIneligibleReason, LeadDebtAccountOwnership, LeadDebtAccountResponsibility, LeadDebtAccountSource, type LeadDebtAccountTradelineSource, type LeadDebtAccountUniversalId, type LeadDistribution, type LeadPatchRequest, LeadPatchRequestDraftType, LeadPatchRequestGoalCategory, LeadPatchRequestHardshipCategory, type LeadReadiness, type LeadReadinessIsProgramRefreshRequired, type LeadReadinessIsUwApproved, type LeadResponse, type LeadResponseReadiness, type LeadTransferRequest, type LeadTransferResponse, type LeadTransferResponseCreatedAt, type LeadTransferResponseId, LeadTransferResponseResponse, type LeadTransferResponseResponseDetails, type LeadTransferResponseResponseReason, type LeadTransferResponseUpdatedAt, type MailingAddress, type PatchAddress, type PatchApplicant, type PatchCoApplicant, type PatchCondition, type PatchDebtAccount, type PaymentOption, type PaymentOptionEvaluationType, type PaymentSchedule, PaymentScheduleDraftType, type PaymentScheduleOption, PaymentScheduleOptionEvaluationType, type ProgramIneligibilityReason, ProgramIneligibilityReasonReasonId, type ProgramRequest, type ProgramSelectionApplicant, type ProgramSelectionRequest, ProgramSelectionRequestDraftType, type ProgramSummaryTaskRequest, type ProgramSummaryTaskResponse, type ReadinessCheck, type ReadinessCheckErrorDetails, type ReadinessCheckErrors, ReadinessCheckType, type ReadinessErrorDetail, type ReadinessErrorDetailField, ReadinessErrorDetailReasonCode, type ReadinessResponse, type ReadinessResponseIsProgramRefreshRequired, type ReadinessResponseIsUwApproved, type RegisterApplicantV2Address, type RegisterApplicantV2Request, type RegisterApplicantV2Response, type SpinwheelNetworkUserRequest, type SpinwheelNetworkUserResponse, type StatelessReadinessRequest, StatelessReadinessRequestGoalCategory, StatelessReadinessRequestHardshipCategory, type TokenCache, type Tracking, type UwSubmissionV2Applicant, type UwSubmissionV2Application, type UwSubmissionV2Response, type UwSubmissionV2ResponseBankingDisclosureEmailMessage, draftTypeOf, isArpcEnvironment };
|