@borrowbetter/arpcsdk 0.7.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 +6 -5
- package/dist/index.d.mts +1340 -641
- package/dist/index.d.ts +1340 -641
- package/dist/index.js +64 -54
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +64 -54
- 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.
|
|
272
|
+
|
|
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.
|
|
239
286
|
|
|
240
|
-
**Published:** 2026-
|
|
241
|
-
* OpenAPI spec version: 2026.
|
|
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
|
+
}
|
|
304
|
+
|
|
305
|
+
/**
|
|
306
|
+
* Generated by orval v7.21.0 🍺
|
|
307
|
+
* Do not edit manually.
|
|
308
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
309
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. 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.
|
|
317
|
+
|
|
318
|
+
⚠️ Patched locally by `openapi/repairs.ts` — this differs from FDR's published spec.
|
|
319
|
+
*/
|
|
320
|
+
type ARPCErrorResponseErrorDetails = ErrorDetails | null;
|
|
261
321
|
|
|
262
322
|
/**
|
|
263
323
|
* Generated by orval v7.21.0 🍺
|
|
264
324
|
* Do not edit manually.
|
|
265
325
|
* 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.
|
|
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.
|
|
267
327
|
|
|
268
|
-
**Published:** 2026-
|
|
269
|
-
* OpenAPI spec version: 2026.
|
|
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,10 @@ 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
|
|
326
389
|
*/
|
|
327
390
|
/**
|
|
328
391
|
* Error context for agreement lifecycle failures
|
|
@@ -337,10 +400,10 @@ interface AgreementErrorDetails {
|
|
|
337
400
|
* Generated by orval v7.21.0 🍺
|
|
338
401
|
* Do not edit manually.
|
|
339
402
|
* ARPC — Achieve Resolution Partner Connect API
|
|
340
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
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.
|
|
341
404
|
|
|
342
|
-
**Published:** 2026-
|
|
343
|
-
* OpenAPI spec version: 2026.
|
|
405
|
+
**Published:** 2026-10-30
|
|
406
|
+
* OpenAPI spec version: 2026.21.0
|
|
344
407
|
*/
|
|
345
408
|
|
|
346
409
|
/**
|
|
@@ -370,10 +433,10 @@ interface AgreementErrorResponse {
|
|
|
370
433
|
* Generated by orval v7.21.0 🍺
|
|
371
434
|
* Do not edit manually.
|
|
372
435
|
* ARPC — Achieve Resolution Partner Connect API
|
|
373
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
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.
|
|
374
437
|
|
|
375
|
-
**Published:** 2026-
|
|
376
|
-
* OpenAPI spec version: 2026.
|
|
438
|
+
**Published:** 2026-10-30
|
|
439
|
+
* OpenAPI spec version: 2026.21.0
|
|
377
440
|
*/
|
|
378
441
|
/**
|
|
379
442
|
* `url` returns a fresh embedded signing URL; `email` triggers DocuSign's email flow and returns no URL.
|
|
@@ -388,10 +451,10 @@ declare const AgreementResendApplicantSigningType: {
|
|
|
388
451
|
* Generated by orval v7.21.0 🍺
|
|
389
452
|
* Do not edit manually.
|
|
390
453
|
* ARPC — Achieve Resolution Partner Connect API
|
|
391
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
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.
|
|
392
455
|
|
|
393
|
-
**Published:** 2026-
|
|
394
|
-
* OpenAPI spec version: 2026.
|
|
456
|
+
**Published:** 2026-10-30
|
|
457
|
+
* OpenAPI spec version: 2026.21.0
|
|
395
458
|
*/
|
|
396
459
|
|
|
397
460
|
/**
|
|
@@ -408,10 +471,10 @@ interface AgreementResendApplicant {
|
|
|
408
471
|
* Generated by orval v7.21.0 🍺
|
|
409
472
|
* Do not edit manually.
|
|
410
473
|
* ARPC — Achieve Resolution Partner Connect API
|
|
411
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
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.
|
|
412
475
|
|
|
413
|
-
**Published:** 2026-
|
|
414
|
-
* OpenAPI spec version: 2026.
|
|
476
|
+
**Published:** 2026-10-30
|
|
477
|
+
* OpenAPI spec version: 2026.21.0
|
|
415
478
|
*/
|
|
416
479
|
|
|
417
480
|
/**
|
|
@@ -427,10 +490,10 @@ interface AgreementResendRequest {
|
|
|
427
490
|
* Generated by orval v7.21.0 🍺
|
|
428
491
|
* Do not edit manually.
|
|
429
492
|
* ARPC — Achieve Resolution Partner Connect API
|
|
430
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
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.
|
|
431
494
|
|
|
432
|
-
**Published:** 2026-
|
|
433
|
-
* OpenAPI spec version: 2026.
|
|
495
|
+
**Published:** 2026-10-30
|
|
496
|
+
* OpenAPI spec version: 2026.21.0
|
|
434
497
|
*/
|
|
435
498
|
/**
|
|
436
499
|
* Request body to void a DRA envelope
|
|
@@ -446,10 +509,10 @@ interface AgreementVoidRequest {
|
|
|
446
509
|
* Generated by orval v7.21.0 🍺
|
|
447
510
|
* Do not edit manually.
|
|
448
511
|
* ARPC — Achieve Resolution Partner Connect API
|
|
449
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
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.
|
|
450
513
|
|
|
451
|
-
**Published:** 2026-
|
|
452
|
-
* OpenAPI spec version: 2026.
|
|
514
|
+
**Published:** 2026-10-30
|
|
515
|
+
* OpenAPI spec version: 2026.21.0
|
|
453
516
|
*/
|
|
454
517
|
/**
|
|
455
518
|
* Void confirmation. Note the camelCase keys, unlike the rest of the API.
|
|
@@ -468,10 +531,10 @@ interface AgreementVoidResponse {
|
|
|
468
531
|
* Generated by orval v7.21.0 🍺
|
|
469
532
|
* Do not edit manually.
|
|
470
533
|
* ARPC — Achieve Resolution Partner Connect API
|
|
471
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
534
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers 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.
|
|
472
535
|
|
|
473
|
-
**Published:** 2026-
|
|
474
|
-
* OpenAPI spec version: 2026.
|
|
536
|
+
**Published:** 2026-10-30
|
|
537
|
+
* OpenAPI spec version: 2026.21.0
|
|
475
538
|
*/
|
|
476
539
|
/**
|
|
477
540
|
* Address used by v2. ZIP is exposed as zip_code on the public request.
|
|
@@ -493,10 +556,10 @@ interface RegisterApplicantV2Address {
|
|
|
493
556
|
* Generated by orval v7.21.0 🍺
|
|
494
557
|
* Do not edit manually.
|
|
495
558
|
* ARPC — Achieve Resolution Partner Connect API
|
|
496
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
497
560
|
|
|
498
|
-
**Published:** 2026-
|
|
499
|
-
* OpenAPI spec version: 2026.
|
|
561
|
+
**Published:** 2026-10-30
|
|
562
|
+
* OpenAPI spec version: 2026.21.0
|
|
500
563
|
*/
|
|
501
564
|
|
|
502
565
|
/**
|
|
@@ -528,7 +591,9 @@ interface Applicant {
|
|
|
528
591
|
date_of_birth: string;
|
|
529
592
|
/** Spinwheel network user token for credit-pull linkage */
|
|
530
593
|
network_token: string;
|
|
594
|
+
/** Applicant's physical / residential address */
|
|
531
595
|
physical_address: RegisterApplicantV2Address;
|
|
596
|
+
/** Applicant's mailing address (all fields optional) */
|
|
532
597
|
mailing_address?: RegisterApplicantV2Address;
|
|
533
598
|
}
|
|
534
599
|
|
|
@@ -536,10 +601,10 @@ interface Applicant {
|
|
|
536
601
|
* Generated by orval v7.21.0 🍺
|
|
537
602
|
* Do not edit manually.
|
|
538
603
|
* ARPC — Achieve Resolution Partner Connect API
|
|
539
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
540
605
|
|
|
541
|
-
**Published:** 2026-
|
|
542
|
-
* OpenAPI spec version: 2026.
|
|
606
|
+
**Published:** 2026-10-30
|
|
607
|
+
* OpenAPI spec version: 2026.21.0
|
|
543
608
|
*/
|
|
544
609
|
interface ApplicationSendEmailResponse {
|
|
545
610
|
status?: string;
|
|
@@ -552,10 +617,10 @@ interface ApplicationSendEmailResponse {
|
|
|
552
617
|
* Generated by orval v7.21.0 🍺
|
|
553
618
|
* Do not edit manually.
|
|
554
619
|
* ARPC — Achieve Resolution Partner Connect API
|
|
555
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
556
621
|
|
|
557
|
-
**Published:** 2026-
|
|
558
|
-
* OpenAPI spec version: 2026.
|
|
622
|
+
**Published:** 2026-10-30
|
|
623
|
+
* OpenAPI spec version: 2026.21.0
|
|
559
624
|
*/
|
|
560
625
|
/**
|
|
561
626
|
* Audit metadata
|
|
@@ -569,10 +634,10 @@ interface AuditInfo {
|
|
|
569
634
|
* Generated by orval v7.21.0 🍺
|
|
570
635
|
* Do not edit manually.
|
|
571
636
|
* ARPC — Achieve Resolution Partner Connect API
|
|
572
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
573
638
|
|
|
574
|
-
**Published:** 2026-
|
|
575
|
-
* OpenAPI spec version: 2026.
|
|
639
|
+
**Published:** 2026-10-30
|
|
640
|
+
* OpenAPI spec version: 2026.21.0
|
|
576
641
|
*/
|
|
577
642
|
/**
|
|
578
643
|
* Account type
|
|
@@ -587,10 +652,10 @@ declare const BankDetailsAccountType: {
|
|
|
587
652
|
* Generated by orval v7.21.0 🍺
|
|
588
653
|
* Do not edit manually.
|
|
589
654
|
* ARPC — Achieve Resolution Partner Connect API
|
|
590
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
591
656
|
|
|
592
|
-
**Published:** 2026-
|
|
593
|
-
* OpenAPI spec version: 2026.
|
|
657
|
+
**Published:** 2026-10-30
|
|
658
|
+
* OpenAPI spec version: 2026.21.0
|
|
594
659
|
*/
|
|
595
660
|
/**
|
|
596
661
|
* Account sub-type
|
|
@@ -605,17 +670,16 @@ declare const BankDetailsAccountSubtype: {
|
|
|
605
670
|
* Generated by orval v7.21.0 🍺
|
|
606
671
|
* Do not edit manually.
|
|
607
672
|
* ARPC — Achieve Resolution Partner Connect API
|
|
608
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
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.
|
|
609
674
|
|
|
610
|
-
**Published:** 2026-
|
|
611
|
-
* OpenAPI spec version: 2026.
|
|
675
|
+
**Published:** 2026-10-30
|
|
676
|
+
* OpenAPI spec version: 2026.21.0
|
|
612
677
|
*/
|
|
613
678
|
|
|
614
679
|
/**
|
|
615
680
|
* Bank account details used for programme drafts
|
|
616
|
-
* @nullable
|
|
617
681
|
*/
|
|
618
|
-
|
|
682
|
+
interface BankDetails {
|
|
619
683
|
/** Bank name */
|
|
620
684
|
name?: string;
|
|
621
685
|
/** Account type */
|
|
@@ -632,6 +696,7 @@ type BankDetails = {
|
|
|
632
696
|
validation_message?: string;
|
|
633
697
|
/** Exact name on the bank account */
|
|
634
698
|
check_exact_name?: string;
|
|
699
|
+
/** Exact address on the bank account */
|
|
635
700
|
check_exact_address?: Address;
|
|
636
701
|
/** Whether a pre-draft has been taken */
|
|
637
702
|
pre_draft?: boolean;
|
|
@@ -641,16 +706,16 @@ type BankDetails = {
|
|
|
641
706
|
mother_maiden_name?: string;
|
|
642
707
|
/** Government-issued ID number for account verification */
|
|
643
708
|
government_issued_id?: string;
|
|
644
|
-
}
|
|
709
|
+
}
|
|
645
710
|
|
|
646
711
|
/**
|
|
647
712
|
* Generated by orval v7.21.0 🍺
|
|
648
713
|
* Do not edit manually.
|
|
649
714
|
* ARPC — Achieve Resolution Partner Connect API
|
|
650
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
651
716
|
|
|
652
|
-
**Published:** 2026-
|
|
653
|
-
* OpenAPI spec version: 2026.
|
|
717
|
+
**Published:** 2026-10-30
|
|
718
|
+
* OpenAPI spec version: 2026.21.0
|
|
654
719
|
*/
|
|
655
720
|
/**
|
|
656
721
|
* Bank account input fields
|
|
@@ -666,10 +731,10 @@ interface BankDetailsInput {
|
|
|
666
731
|
* Generated by orval v7.21.0 🍺
|
|
667
732
|
* Do not edit manually.
|
|
668
733
|
* ARPC — Achieve Resolution Partner Connect API
|
|
669
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
670
735
|
|
|
671
|
-
**Published:** 2026-
|
|
672
|
-
* OpenAPI spec version: 2026.
|
|
736
|
+
**Published:** 2026-10-30
|
|
737
|
+
* OpenAPI spec version: 2026.21.0
|
|
673
738
|
*/
|
|
674
739
|
|
|
675
740
|
/**
|
|
@@ -680,6 +745,7 @@ interface BankUpdateRequest {
|
|
|
680
745
|
banking_disclosure_validation: boolean;
|
|
681
746
|
/** Bank verification code (micro-deposit or other challenge code) */
|
|
682
747
|
verification_code?: string;
|
|
748
|
+
/** Bank account details to associate with this application */
|
|
683
749
|
bank_details: BankDetailsInput;
|
|
684
750
|
}
|
|
685
751
|
|
|
@@ -687,10 +753,10 @@ interface BankUpdateRequest {
|
|
|
687
753
|
* Generated by orval v7.21.0 🍺
|
|
688
754
|
* Do not edit manually.
|
|
689
755
|
* ARPC — Achieve Resolution Partner Connect API
|
|
690
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
691
757
|
|
|
692
|
-
**Published:** 2026-
|
|
693
|
-
* OpenAPI spec version: 2026.
|
|
758
|
+
**Published:** 2026-10-30
|
|
759
|
+
* OpenAPI spec version: 2026.21.0
|
|
694
760
|
*/
|
|
695
761
|
/**
|
|
696
762
|
* Check type identifier
|
|
@@ -705,10 +771,39 @@ declare const CheckType: {
|
|
|
705
771
|
* Generated by orval v7.21.0 🍺
|
|
706
772
|
* Do not edit manually.
|
|
707
773
|
* ARPC — Achieve Resolution Partner Connect API
|
|
708
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
789
|
+
|
|
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.
|
|
709
804
|
|
|
710
|
-
**Published:** 2026-
|
|
711
|
-
* OpenAPI spec version: 2026.
|
|
805
|
+
**Published:** 2026-10-30
|
|
806
|
+
* OpenAPI spec version: 2026.21.0
|
|
712
807
|
*/
|
|
713
808
|
|
|
714
809
|
/**
|
|
@@ -719,26 +814,20 @@ interface Check {
|
|
|
719
814
|
type?: CheckType;
|
|
720
815
|
/** Whether this check passed */
|
|
721
816
|
verified?: boolean;
|
|
722
|
-
/**
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
errors?: (string | null)[] | null;
|
|
727
|
-
/**
|
|
728
|
-
* Structured validation details for this readiness check
|
|
729
|
-
* @nullable
|
|
730
|
-
*/
|
|
731
|
-
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;
|
|
732
821
|
}
|
|
733
822
|
|
|
734
823
|
/**
|
|
735
824
|
* Generated by orval v7.21.0 🍺
|
|
736
825
|
* Do not edit manually.
|
|
737
826
|
* ARPC — Achieve Resolution Partner Connect API
|
|
738
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
739
828
|
|
|
740
|
-
**Published:** 2026-
|
|
741
|
-
* OpenAPI spec version: 2026.
|
|
829
|
+
**Published:** 2026-10-30
|
|
830
|
+
* OpenAPI spec version: 2026.21.0
|
|
742
831
|
*/
|
|
743
832
|
|
|
744
833
|
/**
|
|
@@ -759,7 +848,9 @@ interface CoApplicant {
|
|
|
759
848
|
email?: string;
|
|
760
849
|
/** Date of birth (YYYY-MM-DD) */
|
|
761
850
|
date_of_birth?: string;
|
|
851
|
+
/** Current residential address */
|
|
762
852
|
current_address?: Address;
|
|
853
|
+
/** Mailing address (if different from current) */
|
|
763
854
|
mailing_address?: Address;
|
|
764
855
|
/** Primary monthly income */
|
|
765
856
|
monthly_income?: number;
|
|
@@ -805,10 +896,10 @@ interface CoApplicant {
|
|
|
805
896
|
* Generated by orval v7.21.0 🍺
|
|
806
897
|
* Do not edit manually.
|
|
807
898
|
* ARPC — Achieve Resolution Partner Connect API
|
|
808
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
809
900
|
|
|
810
|
-
**Published:** 2026-
|
|
811
|
-
* OpenAPI spec version: 2026.
|
|
901
|
+
**Published:** 2026-10-30
|
|
902
|
+
* OpenAPI spec version: 2026.21.0
|
|
812
903
|
*/
|
|
813
904
|
/**
|
|
814
905
|
* Required consent strings for regulatory and platform compliance
|
|
@@ -830,10 +921,10 @@ interface Consents {
|
|
|
830
921
|
* Generated by orval v7.21.0 🍺
|
|
831
922
|
* Do not edit manually.
|
|
832
923
|
* ARPC — Achieve Resolution Partner Connect API
|
|
833
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
834
925
|
|
|
835
|
-
**Published:** 2026-
|
|
836
|
-
* OpenAPI spec version: 2026.
|
|
926
|
+
**Published:** 2026-10-30
|
|
927
|
+
* OpenAPI spec version: 2026.21.0
|
|
837
928
|
*/
|
|
838
929
|
/**
|
|
839
930
|
* Lead distribution routing configuration
|
|
@@ -849,10 +940,10 @@ interface LeadDistribution {
|
|
|
849
940
|
* Generated by orval v7.21.0 🍺
|
|
850
941
|
* Do not edit manually.
|
|
851
942
|
* ARPC — Achieve Resolution Partner Connect API
|
|
852
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
853
944
|
|
|
854
|
-
**Published:** 2026-
|
|
855
|
-
* OpenAPI spec version: 2026.
|
|
945
|
+
**Published:** 2026-10-30
|
|
946
|
+
* OpenAPI spec version: 2026.21.0
|
|
856
947
|
*/
|
|
857
948
|
/**
|
|
858
949
|
* Primary hardship category
|
|
@@ -871,10 +962,10 @@ declare const CreateLeadRequestHardshipCategory: {
|
|
|
871
962
|
* Generated by orval v7.21.0 🍺
|
|
872
963
|
* Do not edit manually.
|
|
873
964
|
* ARPC — Achieve Resolution Partner Connect API
|
|
874
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
875
966
|
|
|
876
|
-
**Published:** 2026-
|
|
877
|
-
* OpenAPI spec version: 2026.
|
|
967
|
+
**Published:** 2026-10-30
|
|
968
|
+
* OpenAPI spec version: 2026.21.0
|
|
878
969
|
*/
|
|
879
970
|
/**
|
|
880
971
|
* Primary goal category
|
|
@@ -891,10 +982,10 @@ declare const CreateLeadRequestGoalCategory: {
|
|
|
891
982
|
* Generated by orval v7.21.0 🍺
|
|
892
983
|
* Do not edit manually.
|
|
893
984
|
* ARPC — Achieve Resolution Partner Connect API
|
|
894
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
895
986
|
|
|
896
|
-
**Published:** 2026-
|
|
897
|
-
* OpenAPI spec version: 2026.
|
|
987
|
+
**Published:** 2026-10-30
|
|
988
|
+
* OpenAPI spec version: 2026.21.0
|
|
898
989
|
*/
|
|
899
990
|
|
|
900
991
|
/**
|
|
@@ -927,7 +1018,9 @@ interface LeadApplicantInput {
|
|
|
927
1018
|
email?: string;
|
|
928
1019
|
/** Date of birth (YYYY-MM-DD) */
|
|
929
1020
|
date_of_birth?: string;
|
|
1021
|
+
/** Current residential address */
|
|
930
1022
|
current_address?: Address;
|
|
1023
|
+
/** Mailing address (if different from current) */
|
|
931
1024
|
mailing_address?: Address;
|
|
932
1025
|
/** Primary monthly income */
|
|
933
1026
|
monthly_income?: number;
|
|
@@ -971,10 +1064,10 @@ interface LeadApplicantInput {
|
|
|
971
1064
|
* Generated by orval v7.21.0 🍺
|
|
972
1065
|
* Do not edit manually.
|
|
973
1066
|
* ARPC — Achieve Resolution Partner Connect API
|
|
974
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
975
1068
|
|
|
976
|
-
**Published:** 2026-
|
|
977
|
-
* OpenAPI spec version: 2026.
|
|
1069
|
+
**Published:** 2026-10-30
|
|
1070
|
+
* OpenAPI spec version: 2026.21.0
|
|
978
1071
|
*/
|
|
979
1072
|
/**
|
|
980
1073
|
* Whether the condition is currently active
|
|
@@ -989,10 +1082,10 @@ declare const LeadConditionActive: {
|
|
|
989
1082
|
* Generated by orval v7.21.0 🍺
|
|
990
1083
|
* Do not edit manually.
|
|
991
1084
|
* ARPC — Achieve Resolution Partner Connect API
|
|
992
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
993
1086
|
|
|
994
|
-
**Published:** 2026-
|
|
995
|
-
* OpenAPI spec version: 2026.
|
|
1087
|
+
**Published:** 2026-10-30
|
|
1088
|
+
* OpenAPI spec version: 2026.21.0
|
|
996
1089
|
*/
|
|
997
1090
|
/**
|
|
998
1091
|
* Condition type. soft-condition types omit the verified field in the response.
|
|
@@ -1009,17 +1102,44 @@ declare const LeadConditionType: {
|
|
|
1009
1102
|
* Generated by orval v7.21.0 🍺
|
|
1010
1103
|
* Do not edit manually.
|
|
1011
1104
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1012
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
1013
1134
|
|
|
1014
|
-
**Published:** 2026-
|
|
1015
|
-
* OpenAPI spec version: 2026.
|
|
1135
|
+
**Published:** 2026-10-30
|
|
1136
|
+
* OpenAPI spec version: 2026.21.0
|
|
1016
1137
|
*/
|
|
1017
1138
|
|
|
1018
1139
|
/**
|
|
1019
1140
|
* Underwriting or program condition
|
|
1020
|
-
* @nullable
|
|
1021
1141
|
*/
|
|
1022
|
-
|
|
1142
|
+
interface LeadCondition {
|
|
1023
1143
|
/** Salesforce condition record ID */
|
|
1024
1144
|
id?: string;
|
|
1025
1145
|
/** Human-readable condition name */
|
|
@@ -1028,30 +1148,24 @@ type LeadCondition = {
|
|
|
1028
1148
|
active?: LeadConditionActive;
|
|
1029
1149
|
/** Condition type. soft-condition types omit the verified field in the response. */
|
|
1030
1150
|
type?: LeadConditionType;
|
|
1031
|
-
/**
|
|
1032
|
-
|
|
1033
|
-
* @nullable
|
|
1034
|
-
*/
|
|
1035
|
-
verified?: boolean | null;
|
|
1151
|
+
/** Whether the condition has been verified by underwriting. Absent for soft-condition type. */
|
|
1152
|
+
verified?: LeadConditionVerified;
|
|
1036
1153
|
/** Internal condition template identifier */
|
|
1037
1154
|
condition_id?: string;
|
|
1038
1155
|
/** Applicant or seller response / documentation reference for this condition */
|
|
1039
1156
|
condition_response?: string;
|
|
1040
|
-
/**
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
*/
|
|
1044
|
-
verified_by_debt_consultant?: boolean | null;
|
|
1045
|
-
} | null;
|
|
1157
|
+
/** Whether the condition was verified by a debt consultant */
|
|
1158
|
+
verified_by_debt_consultant?: LeadConditionVerifiedByDebtConsultant;
|
|
1159
|
+
}
|
|
1046
1160
|
|
|
1047
1161
|
/**
|
|
1048
1162
|
* Generated by orval v7.21.0 🍺
|
|
1049
1163
|
* Do not edit manually.
|
|
1050
1164
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1051
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
1052
1166
|
|
|
1053
|
-
**Published:** 2026-
|
|
1054
|
-
* OpenAPI spec version: 2026.
|
|
1167
|
+
**Published:** 2026-10-30
|
|
1168
|
+
* OpenAPI spec version: 2026.21.0
|
|
1055
1169
|
*/
|
|
1056
1170
|
|
|
1057
1171
|
/**
|
|
@@ -1128,10 +1242,25 @@ interface DebtAccount {
|
|
|
1128
1242
|
* Generated by orval v7.21.0 🍺
|
|
1129
1243
|
* Do not edit manually.
|
|
1130
1244
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1131
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
1132
1261
|
|
|
1133
|
-
**Published:** 2026-
|
|
1134
|
-
* OpenAPI spec version: 2026.
|
|
1262
|
+
**Published:** 2026-10-30
|
|
1263
|
+
* OpenAPI spec version: 2026.21.0
|
|
1135
1264
|
*/
|
|
1136
1265
|
|
|
1137
1266
|
/**
|
|
@@ -1202,6 +1331,7 @@ interface CreateLeadRequest {
|
|
|
1202
1331
|
scheduled_distribution_date_and_time?: string;
|
|
1203
1332
|
/** Unique distribution identifier */
|
|
1204
1333
|
distribution_identifier?: string;
|
|
1334
|
+
/** Lead distribution routing settings */
|
|
1205
1335
|
lead_distribution?: LeadDistribution;
|
|
1206
1336
|
/** Monthly child care expenses */
|
|
1207
1337
|
child_care?: number;
|
|
@@ -1263,23 +1393,22 @@ interface CreateLeadRequest {
|
|
|
1263
1393
|
other_expenses_description?: string;
|
|
1264
1394
|
/** Free-text comments on income and expenses */
|
|
1265
1395
|
income_expenses_comments?: string;
|
|
1396
|
+
/** Primary applicant details */
|
|
1266
1397
|
applicant?: LeadApplicantInput;
|
|
1398
|
+
/** Co-applicant details (optional) */
|
|
1267
1399
|
co_applicant?: CoApplicant;
|
|
1268
|
-
/**
|
|
1269
|
-
|
|
1270
|
-
* @nullable
|
|
1271
|
-
*/
|
|
1272
|
-
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;
|
|
1273
1402
|
}
|
|
1274
1403
|
|
|
1275
1404
|
/**
|
|
1276
1405
|
* Generated by orval v7.21.0 🍺
|
|
1277
1406
|
* Do not edit manually.
|
|
1278
1407
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1279
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
1280
1409
|
|
|
1281
|
-
**Published:** 2026-
|
|
1282
|
-
* OpenAPI spec version: 2026.
|
|
1410
|
+
**Published:** 2026-10-30
|
|
1411
|
+
* OpenAPI spec version: 2026.21.0
|
|
1283
1412
|
*/
|
|
1284
1413
|
/**
|
|
1285
1414
|
* Current program / opportunity stage
|
|
@@ -1303,10 +1432,10 @@ declare const LeadApplicationStatus: {
|
|
|
1303
1432
|
* Generated by orval v7.21.0 🍺
|
|
1304
1433
|
* Do not edit manually.
|
|
1305
1434
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1306
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
1307
1436
|
|
|
1308
|
-
**Published:** 2026-
|
|
1309
|
-
* OpenAPI spec version: 2026.
|
|
1437
|
+
**Published:** 2026-10-30
|
|
1438
|
+
* OpenAPI spec version: 2026.21.0
|
|
1310
1439
|
*/
|
|
1311
1440
|
/**
|
|
1312
1441
|
* Client's preferred language
|
|
@@ -1321,10 +1450,24 @@ declare const LeadApplicationLanguage: {
|
|
|
1321
1450
|
* Generated by orval v7.21.0 🍺
|
|
1322
1451
|
* Do not edit manually.
|
|
1323
1452
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1324
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
1454
|
+
|
|
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.
|
|
1325
1468
|
|
|
1326
|
-
**Published:** 2026-
|
|
1327
|
-
* OpenAPI spec version: 2026.
|
|
1469
|
+
**Published:** 2026-10-30
|
|
1470
|
+
* OpenAPI spec version: 2026.21.0
|
|
1328
1471
|
*/
|
|
1329
1472
|
/**
|
|
1330
1473
|
* Bankruptcy status on file
|
|
@@ -1342,10 +1485,39 @@ declare const LeadApplicantBankruptcy: {
|
|
|
1342
1485
|
* Generated by orval v7.21.0 🍺
|
|
1343
1486
|
* Do not edit manually.
|
|
1344
1487
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1345
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
1346
1518
|
|
|
1347
|
-
**Published:** 2026-
|
|
1348
|
-
* OpenAPI spec version: 2026.
|
|
1519
|
+
**Published:** 2026-10-30
|
|
1520
|
+
* OpenAPI spec version: 2026.21.0
|
|
1349
1521
|
*/
|
|
1350
1522
|
/**
|
|
1351
1523
|
* Pay frequency
|
|
@@ -1365,10 +1537,10 @@ declare const LeadApplicantPayFrequency: {
|
|
|
1365
1537
|
* Generated by orval v7.21.0 🍺
|
|
1366
1538
|
* Do not edit manually.
|
|
1367
1539
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1368
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
1369
1541
|
|
|
1370
|
-
**Published:** 2026-
|
|
1371
|
-
* OpenAPI spec version: 2026.
|
|
1542
|
+
**Published:** 2026-10-30
|
|
1543
|
+
* OpenAPI spec version: 2026.21.0
|
|
1372
1544
|
*/
|
|
1373
1545
|
/**
|
|
1374
1546
|
* Current employment status
|
|
@@ -1387,17 +1559,16 @@ declare const LeadApplicantEmploymentStatus: {
|
|
|
1387
1559
|
* Generated by orval v7.21.0 🍺
|
|
1388
1560
|
* Do not edit manually.
|
|
1389
1561
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1390
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
1391
1563
|
|
|
1392
|
-
**Published:** 2026-
|
|
1393
|
-
* OpenAPI spec version: 2026.
|
|
1564
|
+
**Published:** 2026-10-30
|
|
1565
|
+
* OpenAPI spec version: 2026.21.0
|
|
1394
1566
|
*/
|
|
1395
1567
|
|
|
1396
1568
|
/**
|
|
1397
1569
|
* Applicant or co-applicant personal details
|
|
1398
|
-
* @nullable
|
|
1399
1570
|
*/
|
|
1400
|
-
|
|
1571
|
+
interface LeadApplicant {
|
|
1401
1572
|
/** Salesforce record ID — also echoes fdr_applicant_id value via JOLT mapping */
|
|
1402
1573
|
id?: string;
|
|
1403
1574
|
/** Applicant email address */
|
|
@@ -1414,18 +1585,12 @@ type LeadApplicant = {
|
|
|
1414
1585
|
unemployment?: number;
|
|
1415
1586
|
/** Bankruptcy status on file */
|
|
1416
1587
|
bankruptcy?: LeadApplicantBankruptcy;
|
|
1417
|
-
/**
|
|
1418
|
-
|
|
1419
|
-
* @nullable
|
|
1420
|
-
*/
|
|
1421
|
-
conditions?: LeadCondition[] | null;
|
|
1588
|
+
/** Conditions associated with this applicant */
|
|
1589
|
+
conditions?: LeadApplicantConditions;
|
|
1422
1590
|
/** FDR applicant identifier */
|
|
1423
1591
|
fdr_applicant_id?: string;
|
|
1424
|
-
/**
|
|
1425
|
-
|
|
1426
|
-
* @nullable
|
|
1427
|
-
*/
|
|
1428
|
-
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;
|
|
1429
1594
|
/** Credit bureau report ID */
|
|
1430
1595
|
cbr_report_id?: string;
|
|
1431
1596
|
/** Applicant first name */
|
|
@@ -1444,7 +1609,9 @@ type LeadApplicant = {
|
|
|
1444
1609
|
date_of_birth?: string;
|
|
1445
1610
|
/** Social Security Number (masked in logs) */
|
|
1446
1611
|
social_security_number?: string;
|
|
1612
|
+
/** Physical / current address */
|
|
1447
1613
|
current_address?: Address;
|
|
1614
|
+
/** Mailing address, if different from current */
|
|
1448
1615
|
mailing_address?: Address;
|
|
1449
1616
|
/** Applicant's gross monthly income (USD) */
|
|
1450
1617
|
monthly_income?: number;
|
|
@@ -1482,16 +1649,31 @@ type LeadApplicant = {
|
|
|
1482
1649
|
email_opt_out?: boolean;
|
|
1483
1650
|
/** Date of bankruptcy filing (YYYY-MM-DD) */
|
|
1484
1651
|
bankruptcy_date?: string;
|
|
1485
|
-
}
|
|
1652
|
+
}
|
|
1653
|
+
|
|
1654
|
+
/**
|
|
1655
|
+
* Generated by orval v7.21.0 🍺
|
|
1656
|
+
* Do not edit manually.
|
|
1657
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
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
|
+
*/
|
|
1663
|
+
|
|
1664
|
+
/**
|
|
1665
|
+
* Application-level underwriting conditions
|
|
1666
|
+
*/
|
|
1667
|
+
type LeadApplicationConditions = LeadCondition[] | null;
|
|
1486
1668
|
|
|
1487
1669
|
/**
|
|
1488
1670
|
* Generated by orval v7.21.0 🍺
|
|
1489
1671
|
* Do not edit manually.
|
|
1490
1672
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1491
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
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.
|
|
1492
1674
|
|
|
1493
|
-
**Published:** 2026-
|
|
1494
|
-
* OpenAPI spec version: 2026.
|
|
1675
|
+
**Published:** 2026-10-30
|
|
1676
|
+
* OpenAPI spec version: 2026.21.0
|
|
1495
1677
|
*/
|
|
1496
1678
|
/**
|
|
1497
1679
|
* Sub-status of the current stage
|
|
@@ -1558,10 +1740,24 @@ declare const LeadApplicationSubStatus: {
|
|
|
1558
1740
|
* Generated by orval v7.21.0 🍺
|
|
1559
1741
|
* Do not edit manually.
|
|
1560
1742
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1561
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
1744
|
+
|
|
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.
|
|
1562
1758
|
|
|
1563
|
-
**Published:** 2026-
|
|
1564
|
-
* OpenAPI spec version: 2026.
|
|
1759
|
+
**Published:** 2026-10-30
|
|
1760
|
+
* OpenAPI spec version: 2026.21.0
|
|
1565
1761
|
*/
|
|
1566
1762
|
/**
|
|
1567
1763
|
* Indicates whether the program is FDR or CSS serviced
|
|
@@ -1576,10 +1772,10 @@ declare const LeadApplicationFdrOrCss: {
|
|
|
1576
1772
|
* Generated by orval v7.21.0 🍺
|
|
1577
1773
|
* Do not edit manually.
|
|
1578
1774
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1579
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
1580
1776
|
|
|
1581
|
-
**Published:** 2026-
|
|
1582
|
-
* OpenAPI spec version: 2026.
|
|
1777
|
+
**Published:** 2026-10-30
|
|
1778
|
+
* OpenAPI spec version: 2026.21.0
|
|
1583
1779
|
*/
|
|
1584
1780
|
/**
|
|
1585
1781
|
* Draft frequency type
|
|
@@ -1595,10 +1791,10 @@ declare const LeadApplicationDraftType: {
|
|
|
1595
1791
|
* Generated by orval v7.21.0 🍺
|
|
1596
1792
|
* Do not edit manually.
|
|
1597
1793
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1598
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
1599
1795
|
|
|
1600
|
-
**Published:** 2026-
|
|
1601
|
-
* OpenAPI spec version: 2026.
|
|
1796
|
+
**Published:** 2026-10-30
|
|
1797
|
+
* OpenAPI spec version: 2026.21.0
|
|
1602
1798
|
*/
|
|
1603
1799
|
/**
|
|
1604
1800
|
* Whether client is on fixed income. Salesforce returns this as the string \"Yes\" or \"No\" (not a boolean).
|
|
@@ -1613,10 +1809,10 @@ declare const LeadApplicationFixedIncome: {
|
|
|
1613
1809
|
* Generated by orval v7.21.0 🍺
|
|
1614
1810
|
* Do not edit manually.
|
|
1615
1811
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1616
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
1617
1813
|
|
|
1618
|
-
**Published:** 2026-
|
|
1619
|
-
* OpenAPI spec version: 2026.
|
|
1814
|
+
**Published:** 2026-10-30
|
|
1815
|
+
* OpenAPI spec version: 2026.21.0
|
|
1620
1816
|
*/
|
|
1621
1817
|
/**
|
|
1622
1818
|
* Whether the client owns or rents their home
|
|
@@ -1631,10 +1827,10 @@ declare const LeadApplicationOwnOrRent: {
|
|
|
1631
1827
|
* Generated by orval v7.21.0 🍺
|
|
1632
1828
|
* Do not edit manually.
|
|
1633
1829
|
* 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.
|
|
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.
|
|
1635
1831
|
|
|
1636
|
-
**Published:** 2026-
|
|
1637
|
-
* OpenAPI spec version: 2026.
|
|
1832
|
+
**Published:** 2026-10-30
|
|
1833
|
+
* OpenAPI spec version: 2026.21.0
|
|
1638
1834
|
*/
|
|
1639
1835
|
/**
|
|
1640
1836
|
* Primary hardship category
|
|
@@ -1653,10 +1849,24 @@ declare const LeadApplicationHardshipCategory: {
|
|
|
1653
1849
|
* Generated by orval v7.21.0 🍺
|
|
1654
1850
|
* Do not edit manually.
|
|
1655
1851
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1656
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
1853
|
+
|
|
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.
|
|
1657
1867
|
|
|
1658
|
-
**Published:** 2026-
|
|
1659
|
-
* OpenAPI spec version: 2026.
|
|
1868
|
+
**Published:** 2026-10-30
|
|
1869
|
+
* OpenAPI spec version: 2026.21.0
|
|
1660
1870
|
*/
|
|
1661
1871
|
/**
|
|
1662
1872
|
* Client's primary financial goal category
|
|
@@ -1673,10 +1883,24 @@ declare const LeadApplicationGoalCategory: {
|
|
|
1673
1883
|
* Generated by orval v7.21.0 🍺
|
|
1674
1884
|
* Do not edit manually.
|
|
1675
1885
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1676
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
1887
|
+
|
|
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.
|
|
1677
1901
|
|
|
1678
|
-
**Published:** 2026-
|
|
1679
|
-
* OpenAPI spec version: 2026.
|
|
1902
|
+
**Published:** 2026-10-30
|
|
1903
|
+
* OpenAPI spec version: 2026.21.0
|
|
1680
1904
|
*/
|
|
1681
1905
|
/**
|
|
1682
1906
|
* Client's secondary financial goal
|
|
@@ -1697,10 +1921,24 @@ declare const LeadApplicationSecondaryGoal: {
|
|
|
1697
1921
|
* Generated by orval v7.21.0 🍺
|
|
1698
1922
|
* Do not edit manually.
|
|
1699
1923
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1700
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
1701
1939
|
|
|
1702
|
-
**Published:** 2026-
|
|
1703
|
-
* OpenAPI spec version: 2026.
|
|
1940
|
+
**Published:** 2026-10-30
|
|
1941
|
+
* OpenAPI spec version: 2026.21.0
|
|
1704
1942
|
*/
|
|
1705
1943
|
/**
|
|
1706
1944
|
* Source of the credit report pull (also present inside applicant)
|
|
@@ -1715,10 +1953,55 @@ declare const LeadApplicationCreditPullSource: {
|
|
|
1715
1953
|
* Generated by orval v7.21.0 🍺
|
|
1716
1954
|
* Do not edit manually.
|
|
1717
1955
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1718
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
1957
|
+
|
|
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.
|
|
1719
2002
|
|
|
1720
|
-
**Published:** 2026-
|
|
1721
|
-
* OpenAPI spec version: 2026.
|
|
2003
|
+
**Published:** 2026-10-30
|
|
2004
|
+
* OpenAPI spec version: 2026.21.0
|
|
1722
2005
|
*/
|
|
1723
2006
|
/**
|
|
1724
2007
|
* Creditor or original creditor details
|
|
@@ -1754,10 +2037,10 @@ interface LeadCreditor {
|
|
|
1754
2037
|
* Generated by orval v7.21.0 🍺
|
|
1755
2038
|
* Do not edit manually.
|
|
1756
2039
|
* 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. 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.
|
|
1758
2041
|
|
|
1759
|
-
**Published:** 2026-
|
|
1760
|
-
* OpenAPI spec version: 2026.
|
|
2042
|
+
**Published:** 2026-10-30
|
|
2043
|
+
* OpenAPI spec version: 2026.21.0
|
|
1761
2044
|
*/
|
|
1762
2045
|
/**
|
|
1763
2046
|
* Responsibility type for the account
|
|
@@ -1780,10 +2063,10 @@ declare const LeadDebtAccountResponsibility: {
|
|
|
1780
2063
|
* Generated by orval v7.21.0 🍺
|
|
1781
2064
|
* Do not edit manually.
|
|
1782
2065
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1783
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
1784
2067
|
|
|
1785
|
-
**Published:** 2026-
|
|
1786
|
-
* OpenAPI spec version: 2026.
|
|
2068
|
+
**Published:** 2026-10-30
|
|
2069
|
+
* OpenAPI spec version: 2026.21.0
|
|
1787
2070
|
*/
|
|
1788
2071
|
/**
|
|
1789
2072
|
* Ownership of the account
|
|
@@ -1799,10 +2082,10 @@ declare const LeadDebtAccountOwnership: {
|
|
|
1799
2082
|
* Generated by orval v7.21.0 🍺
|
|
1800
2083
|
* Do not edit manually.
|
|
1801
2084
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1802
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
1803
2086
|
|
|
1804
|
-
**Published:** 2026-
|
|
1805
|
-
* OpenAPI spec version: 2026.
|
|
2087
|
+
**Published:** 2026-10-30
|
|
2088
|
+
* OpenAPI spec version: 2026.21.0
|
|
1806
2089
|
*/
|
|
1807
2090
|
/**
|
|
1808
2091
|
* Source of the debt account record
|
|
@@ -1820,10 +2103,39 @@ declare const LeadDebtAccountSource: {
|
|
|
1820
2103
|
* Generated by orval v7.21.0 🍺
|
|
1821
2104
|
* Do not edit manually.
|
|
1822
2105
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1823
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
2122
|
+
|
|
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.
|
|
1824
2136
|
|
|
1825
|
-
**Published:** 2026-
|
|
1826
|
-
* OpenAPI spec version: 2026.
|
|
2137
|
+
**Published:** 2026-10-30
|
|
2138
|
+
* OpenAPI spec version: 2026.21.0
|
|
1827
2139
|
*/
|
|
1828
2140
|
/**
|
|
1829
2141
|
* Type of account
|
|
@@ -1850,76 +2162,115 @@ declare const LeadDebtAccountAccountType: {
|
|
|
1850
2162
|
readonly 'business-debt-loan': "business-debt-loan";
|
|
1851
2163
|
readonly 'government-debt': "government-debt";
|
|
1852
2164
|
readonly 'legal-fees': "legal-fees";
|
|
2165
|
+
readonly unknown: "unknown";
|
|
1853
2166
|
};
|
|
1854
2167
|
|
|
1855
2168
|
/**
|
|
1856
2169
|
* Generated by orval v7.21.0 🍺
|
|
1857
2170
|
* Do not edit manually.
|
|
1858
2171
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1859
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
1860
2173
|
|
|
1861
|
-
**Published:** 2026-
|
|
1862
|
-
* OpenAPI spec version: 2026.
|
|
2174
|
+
**Published:** 2026-10-30
|
|
2175
|
+
* OpenAPI spec version: 2026.21.0
|
|
1863
2176
|
*/
|
|
1864
2177
|
/**
|
|
1865
|
-
*
|
|
2178
|
+
* Credit bureau that reported this tradeline
|
|
1866
2179
|
*/
|
|
1867
|
-
type
|
|
1868
|
-
declare const IneligibleReasonReasonId: {
|
|
1869
|
-
readonly 'account-debt-too-low': "account-debt-too-low";
|
|
1870
|
-
readonly 'ca-ab1405-joint-debt-3rd-party': "ca-ab1405-joint-debt-3rd-party";
|
|
1871
|
-
readonly 'conflict-of-interest-ffam-cplus-balance': "conflict-of-interest-ffam-cplus-balance";
|
|
1872
|
-
readonly 'conflict-of-interest-ffam-fplus-balance': "conflict-of-interest-ffam-fplus-balance";
|
|
1873
|
-
readonly 'credit-union-cross-collateral': "credit-union-cross-collateral";
|
|
1874
|
-
readonly 'debt-too-low': "debt-too-low";
|
|
1875
|
-
readonly 'duplicate-account': "duplicate-account";
|
|
1876
|
-
readonly 'ineligible-applicants': "ineligible-applicants";
|
|
1877
|
-
readonly 'invalid-balance-date': "invalid-balance-date";
|
|
1878
|
-
readonly 'invalid-balance-date-percent-exceeded': "invalid-balance-date-percent-exceeded";
|
|
1879
|
-
readonly 'merchandise-account-too-new': "merchandise-account-too-new";
|
|
1880
|
-
readonly 'secured-loan': "secured-loan";
|
|
1881
|
-
readonly 'single-creditor-collection-debt-percent-exceeded': "single-creditor-collection-debt-percent-exceeded";
|
|
1882
|
-
readonly 'unacceptable-creditor': "unacceptable-creditor";
|
|
1883
|
-
readonly 'unacceptable-education': "unacceptable-education";
|
|
1884
|
-
readonly 'unacceptable-equipment': "unacceptable-equipment";
|
|
1885
|
-
readonly 'unacceptable-government': "unacceptable-government";
|
|
1886
|
-
readonly 'unacceptable-insurance': "unacceptable-insurance";
|
|
1887
|
-
readonly 'unacceptable-legal-fees': "unacceptable-legal-fees";
|
|
1888
|
-
readonly 'unacceptable-mortgage': "unacceptable-mortgage";
|
|
1889
|
-
readonly 'unacceptable-responsibility': "unacceptable-responsibility";
|
|
1890
|
-
readonly 'unacceptable-secured': "unacceptable-secured";
|
|
1891
|
-
readonly 'unacceptable-state': "unacceptable-state";
|
|
1892
|
-
};
|
|
2180
|
+
type LeadDebtAccountTradelineSource = string | null;
|
|
1893
2181
|
|
|
1894
2182
|
/**
|
|
1895
2183
|
* Generated by orval v7.21.0 🍺
|
|
1896
2184
|
* Do not edit manually.
|
|
1897
2185
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1898
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
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.
|
|
1899
2187
|
|
|
1900
|
-
**Published:** 2026-
|
|
1901
|
-
* OpenAPI spec version: 2026.
|
|
2188
|
+
**Published:** 2026-10-30
|
|
2189
|
+
* OpenAPI spec version: 2026.21.0
|
|
1902
2190
|
*/
|
|
1903
|
-
|
|
1904
2191
|
/**
|
|
1905
|
-
*
|
|
1906
|
-
* @nullable
|
|
2192
|
+
* Universal identifier for the tradeline across credit bureaus
|
|
1907
2193
|
*/
|
|
1908
|
-
type
|
|
1909
|
-
/** Ineligibility reason identifier (PS_Id__c from PS_Evaluations_Config__mdt). See PgIneligibleReasonId for the full set of known values. */
|
|
1910
|
-
reason_id?: IneligibleReasonReasonId;
|
|
1911
|
-
} | null;
|
|
2194
|
+
type LeadDebtAccountUniversalId = string | null;
|
|
1912
2195
|
|
|
1913
2196
|
/**
|
|
1914
2197
|
* Generated by orval v7.21.0 🍺
|
|
1915
2198
|
* Do not edit manually.
|
|
1916
2199
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1917
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1918
|
-
|
|
1919
|
-
**Published:** 2026-
|
|
1920
|
-
* OpenAPI spec version: 2026.
|
|
1921
|
-
*/
|
|
1922
|
-
|
|
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";
|
|
2225
|
+
readonly 'conflict-of-interest-ffam-cplus-balance': "conflict-of-interest-ffam-cplus-balance";
|
|
2226
|
+
readonly 'conflict-of-interest-ffam-fplus-balance': "conflict-of-interest-ffam-fplus-balance";
|
|
2227
|
+
readonly 'external-debt-acceleration-loan': "external-debt-acceleration-loan";
|
|
2228
|
+
readonly 'unacceptable-equipment': "unacceptable-equipment";
|
|
2229
|
+
};
|
|
2230
|
+
|
|
2231
|
+
/**
|
|
2232
|
+
* Generated by orval v7.21.0 🍺
|
|
2233
|
+
* Do not edit manually.
|
|
2234
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
2236
|
+
|
|
2237
|
+
**Published:** 2026-10-30
|
|
2238
|
+
* OpenAPI spec version: 2026.21.0
|
|
2239
|
+
*/
|
|
2240
|
+
|
|
2241
|
+
/**
|
|
2242
|
+
* Individual debt-account ineligibility reason; does not by itself imply program ineligibility
|
|
2243
|
+
*/
|
|
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
|
+
}
|
|
2248
|
+
|
|
2249
|
+
/**
|
|
2250
|
+
* Generated by orval v7.21.0 🍺
|
|
2251
|
+
* Do not edit manually.
|
|
2252
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
2254
|
+
|
|
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
|
|
2272
|
+
*/
|
|
2273
|
+
|
|
1923
2274
|
/**
|
|
1924
2275
|
* Debt account enrolled in or considered for the program
|
|
1925
2276
|
*/
|
|
@@ -1928,6 +2279,7 @@ interface LeadDebtAccount {
|
|
|
1928
2279
|
id?: string;
|
|
1929
2280
|
/** Salesforce record name */
|
|
1930
2281
|
name?: string;
|
|
2282
|
+
/** Current creditor details */
|
|
1931
2283
|
creditor?: LeadCreditor;
|
|
1932
2284
|
/** Number of months in the account's term */
|
|
1933
2285
|
terms?: number;
|
|
@@ -1945,24 +2297,21 @@ interface LeadDebtAccount {
|
|
|
1945
2297
|
rank?: number;
|
|
1946
2298
|
/** Whether this debt account has been verified by underwriting. Converted from Salesforce Yes/No string to boolean. */
|
|
1947
2299
|
verified?: boolean;
|
|
1948
|
-
/**
|
|
1949
|
-
|
|
1950
|
-
|
|
1951
|
-
|
|
1952
|
-
conditions?: LeadCondition[] | null;
|
|
2300
|
+
/** Conditions specific to this debt account */
|
|
2301
|
+
conditions?: LeadDebtAccountConditions;
|
|
2302
|
+
/** Seller-assigned debt account reference ID */
|
|
2303
|
+
reference_id?: string;
|
|
1953
2304
|
/** External lead platform identifier for this account */
|
|
1954
2305
|
lead_platform_id?: string;
|
|
1955
2306
|
/** Credit bureau trade-line ID */
|
|
1956
2307
|
credit_report_trade_line_id?: string;
|
|
1957
2308
|
/** Display name of the current creditor (from meta-creditor other_name) */
|
|
1958
2309
|
creditor_name?: string;
|
|
1959
|
-
/**
|
|
1960
|
-
|
|
1961
|
-
* @nullable
|
|
1962
|
-
*/
|
|
1963
|
-
current_creditor_other?: string | null;
|
|
2310
|
+
/** Alternative creditor name when creditor is not in the standard list */
|
|
2311
|
+
current_creditor_other?: LeadDebtAccountCurrentCreditorOther;
|
|
1964
2312
|
/** Display name of the original creditor. Falls back to original_creditor.name when other_name is absent. */
|
|
1965
2313
|
original_creditor_name?: string;
|
|
2314
|
+
/** Original creditor details */
|
|
1966
2315
|
original_creditor?: LeadCreditor;
|
|
1967
2316
|
/** Creditor account number */
|
|
1968
2317
|
account_number?: string;
|
|
@@ -2012,16 +2361,10 @@ interface LeadDebtAccount {
|
|
|
2012
2361
|
credit_utilization?: string;
|
|
2013
2362
|
/** Most recent delinquency bucket reported */
|
|
2014
2363
|
most_recent_delinquency?: string;
|
|
2015
|
-
/**
|
|
2016
|
-
|
|
2017
|
-
|
|
2018
|
-
|
|
2019
|
-
tradeline_source?: string | null;
|
|
2020
|
-
/**
|
|
2021
|
-
* Universal identifier for the tradeline across credit bureaus
|
|
2022
|
-
* @nullable
|
|
2023
|
-
*/
|
|
2024
|
-
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;
|
|
2025
2368
|
/** First name of the joint account holder, if applicable */
|
|
2026
2369
|
joint_holder_first_name?: string;
|
|
2027
2370
|
/** Last name of the joint account holder, if applicable */
|
|
@@ -2034,69 +2377,71 @@ interface LeadDebtAccount {
|
|
|
2034
2377
|
months_to_settle?: string;
|
|
2035
2378
|
/** True when this debt account belongs to the co-applicant */
|
|
2036
2379
|
co_applicant?: boolean;
|
|
2037
|
-
/**
|
|
2038
|
-
|
|
2039
|
-
* @nullable
|
|
2040
|
-
*/
|
|
2041
|
-
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;
|
|
2042
2382
|
}
|
|
2043
2383
|
|
|
2044
2384
|
/**
|
|
2045
2385
|
* Generated by orval v7.21.0 🍺
|
|
2046
2386
|
* Do not edit manually.
|
|
2047
2387
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2048
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
2049
2389
|
|
|
2050
|
-
**Published:** 2026-
|
|
2051
|
-
* OpenAPI spec version: 2026.
|
|
2390
|
+
**Published:** 2026-10-30
|
|
2391
|
+
* OpenAPI spec version: 2026.21.0
|
|
2052
2392
|
*/
|
|
2053
2393
|
/**
|
|
2054
2394
|
* Tier label for this payment option
|
|
2055
|
-
* @nullable
|
|
2056
2395
|
*/
|
|
2057
|
-
type PaymentOptionEvaluationType =
|
|
2058
|
-
declare const PaymentOptionEvaluationType: {
|
|
2059
|
-
readonly Most_Affordable: "Most Affordable";
|
|
2060
|
-
readonly Best_Value: "Best Value";
|
|
2061
|
-
readonly Fastest: "Fastest";
|
|
2062
|
-
};
|
|
2396
|
+
type PaymentOptionEvaluationType = 'Most Affordable' | 'Best Value' | 'Fastest' | null;
|
|
2063
2397
|
|
|
2064
2398
|
/**
|
|
2065
2399
|
* Generated by orval v7.21.0 🍺
|
|
2066
2400
|
* Do not edit manually.
|
|
2067
2401
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2068
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
2069
2403
|
|
|
2070
|
-
**Published:** 2026-
|
|
2071
|
-
* OpenAPI spec version: 2026.
|
|
2404
|
+
**Published:** 2026-10-30
|
|
2405
|
+
* OpenAPI spec version: 2026.21.0
|
|
2072
2406
|
*/
|
|
2073
2407
|
|
|
2074
2408
|
/**
|
|
2075
2409
|
* A single selectable payment option
|
|
2076
|
-
* @nullable
|
|
2077
2410
|
*/
|
|
2078
|
-
|
|
2411
|
+
interface PaymentOption {
|
|
2079
2412
|
/** Monthly deposit amount for this option (USD) */
|
|
2080
2413
|
monthly_deposit?: number;
|
|
2081
2414
|
/** Total program cost for this option (USD) */
|
|
2082
2415
|
program_cost?: number;
|
|
2083
2416
|
/** Program length for this option (months) */
|
|
2084
2417
|
program_length?: number;
|
|
2085
|
-
/**
|
|
2086
|
-
* Tier label for this payment option
|
|
2087
|
-
* @nullable
|
|
2088
|
-
*/
|
|
2418
|
+
/** Tier label for this payment option */
|
|
2089
2419
|
evaluation_type?: PaymentOptionEvaluationType;
|
|
2090
|
-
}
|
|
2420
|
+
}
|
|
2091
2421
|
|
|
2092
2422
|
/**
|
|
2093
2423
|
* Generated by orval v7.21.0 🍺
|
|
2094
2424
|
* Do not edit manually.
|
|
2095
2425
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2096
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
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.
|
|
2097
2427
|
|
|
2098
|
-
**Published:** 2026-
|
|
2099
|
-
* OpenAPI spec version: 2026.
|
|
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;
|
|
2436
|
+
|
|
2437
|
+
/**
|
|
2438
|
+
* Generated by orval v7.21.0 🍺
|
|
2439
|
+
* Do not edit manually.
|
|
2440
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
2442
|
+
|
|
2443
|
+
**Published:** 2026-10-30
|
|
2444
|
+
* OpenAPI spec version: 2026.21.0
|
|
2100
2445
|
*/
|
|
2101
2446
|
/**
|
|
2102
2447
|
* Draft frequency type
|
|
@@ -2112,10 +2457,10 @@ declare const PaymentScheduleDraftType: {
|
|
|
2112
2457
|
* Generated by orval v7.21.0 🍺
|
|
2113
2458
|
* Do not edit manually.
|
|
2114
2459
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2115
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
2116
2461
|
|
|
2117
|
-
**Published:** 2026-
|
|
2118
|
-
* OpenAPI spec version: 2026.
|
|
2462
|
+
**Published:** 2026-10-30
|
|
2463
|
+
* OpenAPI spec version: 2026.21.0
|
|
2119
2464
|
*/
|
|
2120
2465
|
|
|
2121
2466
|
/**
|
|
@@ -2136,10 +2481,10 @@ interface PaymentSchedule {
|
|
|
2136
2481
|
* Generated by orval v7.21.0 🍺
|
|
2137
2482
|
* Do not edit manually.
|
|
2138
2483
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2139
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
2140
2485
|
|
|
2141
|
-
**Published:** 2026-
|
|
2142
|
-
* OpenAPI spec version: 2026.
|
|
2486
|
+
**Published:** 2026-10-30
|
|
2487
|
+
* OpenAPI spec version: 2026.21.0
|
|
2143
2488
|
*/
|
|
2144
2489
|
/**
|
|
2145
2490
|
* Tier label for this schedule option
|
|
@@ -2155,17 +2500,16 @@ declare const PaymentScheduleOptionEvaluationType: {
|
|
|
2155
2500
|
* Generated by orval v7.21.0 🍺
|
|
2156
2501
|
* Do not edit manually.
|
|
2157
2502
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2158
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
2159
2504
|
|
|
2160
|
-
**Published:** 2026-
|
|
2161
|
-
* OpenAPI spec version: 2026.
|
|
2505
|
+
**Published:** 2026-10-30
|
|
2506
|
+
* OpenAPI spec version: 2026.21.0
|
|
2162
2507
|
*/
|
|
2163
2508
|
|
|
2164
2509
|
/**
|
|
2165
2510
|
* A payment tier with three draft-frequency schedule breakdowns
|
|
2166
|
-
* @nullable
|
|
2167
2511
|
*/
|
|
2168
|
-
|
|
2512
|
+
interface PaymentScheduleOption {
|
|
2169
2513
|
/** Schedule option identifier */
|
|
2170
2514
|
id?: string;
|
|
2171
2515
|
/** Available draft schedules for this option (regular, split, bi-weekly) */
|
|
@@ -2176,16 +2520,104 @@ type PaymentScheduleOption = {
|
|
|
2176
2520
|
program_length?: number;
|
|
2177
2521
|
/** Total program cost for this option (USD) */
|
|
2178
2522
|
program_cost?: number;
|
|
2179
|
-
}
|
|
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
|
+
}
|
|
2180
2597
|
|
|
2181
2598
|
/**
|
|
2182
2599
|
* Generated by orval v7.21.0 🍺
|
|
2183
2600
|
* Do not edit manually.
|
|
2184
2601
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2185
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
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
|
+
*/
|
|
2186
2607
|
|
|
2187
|
-
|
|
2188
|
-
*
|
|
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;
|
|
2612
|
+
|
|
2613
|
+
/**
|
|
2614
|
+
* Generated by orval v7.21.0 🍺
|
|
2615
|
+
* Do not edit manually.
|
|
2616
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
2617
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. Documentation snapshot: 2026-10-30. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2618
|
+
|
|
2619
|
+
**Published:** 2026-10-30
|
|
2620
|
+
* OpenAPI spec version: 2026.21.0
|
|
2189
2621
|
*/
|
|
2190
2622
|
|
|
2191
2623
|
/**
|
|
@@ -2198,11 +2630,8 @@ interface LeadApplication {
|
|
|
2198
2630
|
state?: string;
|
|
2199
2631
|
/** Client's preferred language */
|
|
2200
2632
|
language?: LeadApplicationLanguage;
|
|
2201
|
-
/**
|
|
2202
|
-
|
|
2203
|
-
* @nullable
|
|
2204
|
-
*/
|
|
2205
|
-
eligible?: boolean | null;
|
|
2633
|
+
/** Whether this application passed program eligibility checks */
|
|
2634
|
+
eligible?: LeadApplicationEligible;
|
|
2206
2635
|
/** Program type / form type */
|
|
2207
2636
|
type?: string;
|
|
2208
2637
|
/** Responsibility level of the current owner (e.g. Debt Consultant, Underwriter) */
|
|
@@ -2211,19 +2640,14 @@ interface LeadApplication {
|
|
|
2211
2640
|
refreshed?: boolean;
|
|
2212
2641
|
/** Monthly utilities expenses (USD) */
|
|
2213
2642
|
utilities?: number;
|
|
2643
|
+
/** Primary applicant details */
|
|
2214
2644
|
applicant?: LeadApplicant;
|
|
2215
|
-
/**
|
|
2216
|
-
|
|
2217
|
-
* @nullable
|
|
2218
|
-
*/
|
|
2219
|
-
conditions?: LeadCondition[] | null;
|
|
2645
|
+
/** Application-level underwriting conditions */
|
|
2646
|
+
conditions?: LeadApplicationConditions;
|
|
2220
2647
|
/** Sub-status of the current stage */
|
|
2221
2648
|
sub_status?: LeadApplicationSubStatus;
|
|
2222
|
-
/**
|
|
2223
|
-
|
|
2224
|
-
* @nullable
|
|
2225
|
-
*/
|
|
2226
|
-
dex_flow_status?: string | null;
|
|
2649
|
+
/** DEX-specific flow status set by the partner integration */
|
|
2650
|
+
dex_flow_status?: LeadApplicationDexFlowStatus;
|
|
2227
2651
|
/** Indicates whether the program is FDR or CSS serviced */
|
|
2228
2652
|
fdr_or_css?: LeadApplicationFdrOrCss;
|
|
2229
2653
|
/** Whether this application has a co-applicant */
|
|
@@ -2380,18 +2804,12 @@ interface LeadApplication {
|
|
|
2380
2804
|
other_expenses_describe?: number;
|
|
2381
2805
|
/** Primary hardship category */
|
|
2382
2806
|
hardship_category?: LeadApplicationHardshipCategory;
|
|
2383
|
-
/**
|
|
2384
|
-
|
|
2385
|
-
* @nullable
|
|
2386
|
-
*/
|
|
2387
|
-
hardship_category_other?: string | null;
|
|
2807
|
+
/** Free-text hardship description when category is 'Other' */
|
|
2808
|
+
hardship_category_other?: LeadApplicationHardshipCategoryOther;
|
|
2388
2809
|
/** Client's primary financial goal category */
|
|
2389
2810
|
goal_category?: LeadApplicationGoalCategory;
|
|
2390
|
-
/**
|
|
2391
|
-
|
|
2392
|
-
* @nullable
|
|
2393
|
-
*/
|
|
2394
|
-
goal_category_other?: string | null;
|
|
2811
|
+
/** Free-text goal when category is 'Other' */
|
|
2812
|
+
goal_category_other?: LeadApplicationGoalCategoryOther;
|
|
2395
2813
|
/** Client's secondary financial goal */
|
|
2396
2814
|
secondary_goal?: LeadApplicationSecondaryGoal;
|
|
2397
2815
|
/** Justification for housing cost amount */
|
|
@@ -2412,11 +2830,8 @@ interface LeadApplication {
|
|
|
2412
2830
|
negative_cash_flow_grounds_for_exception?: string;
|
|
2413
2831
|
/** Justification for net income amount */
|
|
2414
2832
|
income_justification?: string;
|
|
2415
|
-
/**
|
|
2416
|
-
|
|
2417
|
-
* @nullable
|
|
2418
|
-
*/
|
|
2419
|
-
law_firm_id?: string | null;
|
|
2833
|
+
/** Assigned law firm identifier */
|
|
2834
|
+
law_firm_id?: LeadApplicationLawFirmId;
|
|
2420
2835
|
/** Salesforce record creation timestamp */
|
|
2421
2836
|
created_date?: string;
|
|
2422
2837
|
/** Salesforce record close date (YYYY-MM-DD) */
|
|
@@ -2483,45 +2898,36 @@ interface LeadApplication {
|
|
|
2483
2898
|
consent_checked?: boolean;
|
|
2484
2899
|
/** Whether IDQ (Identity Quality) check has been completed */
|
|
2485
2900
|
idq_checked?: boolean;
|
|
2486
|
-
/**
|
|
2487
|
-
|
|
2488
|
-
|
|
2489
|
-
|
|
2490
|
-
|
|
2491
|
-
|
|
2492
|
-
|
|
2493
|
-
|
|
2494
|
-
*/
|
|
2495
|
-
co_applicant_cbr_report_id?: string | null;
|
|
2496
|
-
co_applicant?: LeadApplicant;
|
|
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;
|
|
2497
2909
|
/** Debt accounts associated with this application */
|
|
2498
2910
|
debt_accounts?: LeadDebtAccount[];
|
|
2499
|
-
/**
|
|
2500
|
-
|
|
2501
|
-
|
|
2502
|
-
|
|
2503
|
-
|
|
2504
|
-
|
|
2505
|
-
|
|
2506
|
-
|
|
2507
|
-
|
|
2508
|
-
|
|
2509
|
-
bank_details?: BankDetails;
|
|
2510
|
-
/**
|
|
2511
|
-
* Reasons the application is ineligible, if any. Normalised from a comma-separated string to an array of reason objects.
|
|
2512
|
-
* @nullable
|
|
2513
|
-
*/
|
|
2514
|
-
ineligible_reason?: IneligibleReason[] | null;
|
|
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;
|
|
2515
2921
|
}
|
|
2516
2922
|
|
|
2517
2923
|
/**
|
|
2518
2924
|
* Generated by orval v7.21.0 🍺
|
|
2519
2925
|
* Do not edit manually.
|
|
2520
2926
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2521
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
2522
2928
|
|
|
2523
|
-
**Published:** 2026-
|
|
2524
|
-
* OpenAPI spec version: 2026.
|
|
2929
|
+
**Published:** 2026-10-30
|
|
2930
|
+
* OpenAPI spec version: 2026.21.0
|
|
2525
2931
|
*/
|
|
2526
2932
|
|
|
2527
2933
|
/**
|
|
@@ -2534,6 +2940,7 @@ interface CreateLeadResponse {
|
|
|
2534
2940
|
fdr_applicant_id?: string;
|
|
2535
2941
|
/** Human-readable result message */
|
|
2536
2942
|
message?: string;
|
|
2943
|
+
/** Full application object including program offer, debt accounts, and conditions */
|
|
2537
2944
|
application?: LeadApplication;
|
|
2538
2945
|
}
|
|
2539
2946
|
|
|
@@ -2541,28 +2948,27 @@ interface CreateLeadResponse {
|
|
|
2541
2948
|
* Generated by orval v7.21.0 🍺
|
|
2542
2949
|
* Do not edit manually.
|
|
2543
2950
|
* 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. 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.
|
|
2545
2952
|
|
|
2546
|
-
**Published:** 2026-
|
|
2547
|
-
* OpenAPI spec version: 2026.
|
|
2953
|
+
**Published:** 2026-10-30
|
|
2954
|
+
* OpenAPI spec version: 2026.21.0
|
|
2548
2955
|
*/
|
|
2549
2956
|
/**
|
|
2550
2957
|
* Consent record for soft credit pull
|
|
2551
|
-
* @nullable
|
|
2552
2958
|
*/
|
|
2553
|
-
|
|
2959
|
+
interface CreditPullConsent {
|
|
2554
2960
|
/** ISO-8601 datetime when consent was obtained (must start with YYYY-MM-DD) */
|
|
2555
2961
|
date_time: string;
|
|
2556
|
-
}
|
|
2962
|
+
}
|
|
2557
2963
|
|
|
2558
2964
|
/**
|
|
2559
2965
|
* Generated by orval v7.21.0 🍺
|
|
2560
2966
|
* Do not edit manually.
|
|
2561
2967
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2562
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
2563
2969
|
|
|
2564
|
-
**Published:** 2026-
|
|
2565
|
-
* OpenAPI spec version: 2026.
|
|
2970
|
+
**Published:** 2026-10-30
|
|
2971
|
+
* OpenAPI spec version: 2026.21.0
|
|
2566
2972
|
*/
|
|
2567
2973
|
/**
|
|
2568
2974
|
* Applicant signing URL details
|
|
@@ -2576,10 +2982,10 @@ interface DraApplicant {
|
|
|
2576
2982
|
* Generated by orval v7.21.0 🍺
|
|
2577
2983
|
* Do not edit manually.
|
|
2578
2984
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2579
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
2580
2986
|
|
|
2581
|
-
**Published:** 2026-
|
|
2582
|
-
* OpenAPI spec version: 2026.
|
|
2987
|
+
**Published:** 2026-10-30
|
|
2988
|
+
* OpenAPI spec version: 2026.21.0
|
|
2583
2989
|
*/
|
|
2584
2990
|
/**
|
|
2585
2991
|
* DocuSign signing method. Use 'url' for embedded signing, 'email' for standard email signing.
|
|
@@ -2594,10 +3000,10 @@ declare const DraApplicantInputSigningType: {
|
|
|
2594
3000
|
* Generated by orval v7.21.0 🍺
|
|
2595
3001
|
* Do not edit manually.
|
|
2596
3002
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2597
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
2598
3004
|
|
|
2599
|
-
**Published:** 2026-
|
|
2600
|
-
* OpenAPI spec version: 2026.
|
|
3005
|
+
**Published:** 2026-10-30
|
|
3006
|
+
* OpenAPI spec version: 2026.21.0
|
|
2601
3007
|
*/
|
|
2602
3008
|
|
|
2603
3009
|
/**
|
|
@@ -2612,10 +3018,10 @@ interface DraApplicantInput {
|
|
|
2612
3018
|
* Generated by orval v7.21.0 🍺
|
|
2613
3019
|
* Do not edit manually.
|
|
2614
3020
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2615
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
2616
3022
|
|
|
2617
|
-
**Published:** 2026-
|
|
2618
|
-
* OpenAPI spec version: 2026.
|
|
3023
|
+
**Published:** 2026-10-30
|
|
3024
|
+
* OpenAPI spec version: 2026.21.0
|
|
2619
3025
|
*/
|
|
2620
3026
|
|
|
2621
3027
|
/**
|
|
@@ -2624,23 +3030,27 @@ interface DraApplicantInput {
|
|
|
2624
3030
|
interface DraRequest {
|
|
2625
3031
|
/** URL to redirect the applicant to after completing or declining the DocuSign session */
|
|
2626
3032
|
returning_url?: string;
|
|
3033
|
+
/** Applicant signing preferences */
|
|
2627
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;
|
|
2628
3037
|
}
|
|
2629
3038
|
|
|
2630
3039
|
/**
|
|
2631
3040
|
* Generated by orval v7.21.0 🍺
|
|
2632
3041
|
* Do not edit manually.
|
|
2633
3042
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2634
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
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.
|
|
2635
3044
|
|
|
2636
|
-
**Published:** 2026-
|
|
2637
|
-
* OpenAPI spec version: 2026.
|
|
3045
|
+
**Published:** 2026-10-30
|
|
3046
|
+
* OpenAPI spec version: 2026.21.0
|
|
2638
3047
|
*/
|
|
2639
3048
|
|
|
2640
3049
|
/**
|
|
2641
3050
|
* Response containing the DocuSign envelope ID and embedded signing URL
|
|
2642
3051
|
*/
|
|
2643
3052
|
interface DraResponse {
|
|
3053
|
+
/** Applicant signing details */
|
|
2644
3054
|
applicant?: DraApplicant;
|
|
2645
3055
|
/** DocuSign envelope ID for this signing session */
|
|
2646
3056
|
envelopeId?: string;
|
|
@@ -2650,10 +3060,10 @@ interface DraResponse {
|
|
|
2650
3060
|
* Generated by orval v7.21.0 🍺
|
|
2651
3061
|
* Do not edit manually.
|
|
2652
3062
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2653
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
2654
3064
|
|
|
2655
|
-
**Published:** 2026-
|
|
2656
|
-
* OpenAPI spec version: 2026.
|
|
3065
|
+
**Published:** 2026-10-30
|
|
3066
|
+
* OpenAPI spec version: 2026.21.0
|
|
2657
3067
|
*/
|
|
2658
3068
|
/**
|
|
2659
3069
|
* Address for eligibility request
|
|
@@ -2675,10 +3085,27 @@ interface EligibilityAddress {
|
|
|
2675
3085
|
* Generated by orval v7.21.0 🍺
|
|
2676
3086
|
* Do not edit manually.
|
|
2677
3087
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2678
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
2679
3106
|
|
|
2680
|
-
**Published:** 2026-
|
|
2681
|
-
* OpenAPI spec version: 2026.
|
|
3107
|
+
**Published:** 2026-10-30
|
|
3108
|
+
* OpenAPI spec version: 2026.21.0
|
|
2682
3109
|
*/
|
|
2683
3110
|
|
|
2684
3111
|
/**
|
|
@@ -2695,35 +3122,72 @@ interface EligibilityApplicant {
|
|
|
2695
3122
|
evening_phone_number?: string;
|
|
2696
3123
|
/** Date of birth (YYYY-MM-DD) */
|
|
2697
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. */
|
|
2698
3128
|
current_address?: EligibilityAddress;
|
|
3129
|
+
/** Mailing address (optional) */
|
|
2699
3130
|
mailing_address?: EligibilityAddress;
|
|
2700
|
-
|
|
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;
|
|
2701
3135
|
}
|
|
2702
3136
|
|
|
2703
3137
|
/**
|
|
2704
3138
|
* Generated by orval v7.21.0 🍺
|
|
2705
3139
|
* Do not edit manually.
|
|
2706
3140
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2707
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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
|
+
*/
|
|
2708
3146
|
|
|
2709
|
-
|
|
2710
|
-
*
|
|
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.
|
|
3172
|
+
|
|
3173
|
+
**Published:** 2026-10-30
|
|
3174
|
+
* OpenAPI spec version: 2026.21.0
|
|
2711
3175
|
*/
|
|
2712
3176
|
|
|
2713
3177
|
/**
|
|
2714
3178
|
* Program data returned by the eligibility endpoint. A focused subset of the full lead application object.
|
|
2715
3179
|
*/
|
|
2716
3180
|
interface EligibilityApplication {
|
|
3181
|
+
/** Applicant details including eligibility token */
|
|
2717
3182
|
applicant?: LeadApplicant;
|
|
2718
3183
|
/** Debt accounts used in the eligibility calculation */
|
|
2719
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;
|
|
2720
3187
|
/** Selectable payment options (3 tiers) */
|
|
2721
3188
|
payment_options?: PaymentOption[];
|
|
2722
|
-
/**
|
|
2723
|
-
|
|
2724
|
-
* @nullable
|
|
2725
|
-
*/
|
|
2726
|
-
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;
|
|
2727
3191
|
/** Total enrolled debt (USD) */
|
|
2728
3192
|
estimated_total_debt?: number;
|
|
2729
3193
|
/** Total cost if no action taken (USD) */
|
|
@@ -2790,16 +3254,44 @@ interface EligibilityApplication {
|
|
|
2790
3254
|
* Generated by orval v7.21.0 🍺
|
|
2791
3255
|
* Do not edit manually.
|
|
2792
3256
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2793
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
2794
3272
|
|
|
2795
|
-
**Published:** 2026-
|
|
2796
|
-
* OpenAPI spec version: 2026.
|
|
3273
|
+
**Published:** 2026-10-30
|
|
3274
|
+
* OpenAPI spec version: 2026.21.0
|
|
2797
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.
|
|
3286
|
+
|
|
3287
|
+
**Published:** 2026-10-30
|
|
3288
|
+
* OpenAPI spec version: 2026.21.0
|
|
3289
|
+
*/
|
|
3290
|
+
|
|
2798
3291
|
/**
|
|
2799
3292
|
* Debt account entry for eligibility check (no-credit-pull path)
|
|
2800
|
-
* @nullable
|
|
2801
3293
|
*/
|
|
2802
|
-
|
|
3294
|
+
interface EligibilityDebtAccount {
|
|
2803
3295
|
/** Origin of this debt account record */
|
|
2804
3296
|
source?: string;
|
|
2805
3297
|
/** Seller-assigned reference ID */
|
|
@@ -2810,32 +3302,41 @@ type EligibilityDebtAccount = {
|
|
|
2810
3302
|
estimated_debt?: number;
|
|
2811
3303
|
/** Current minimum monthly payment */
|
|
2812
3304
|
current_monthly_payment?: number;
|
|
2813
|
-
/**
|
|
2814
|
-
|
|
2815
|
-
* @nullable
|
|
2816
|
-
*/
|
|
2817
|
-
current_creditor_other?: string | null;
|
|
3305
|
+
/** Alternative creditor name when creditor is not in the standard list */
|
|
3306
|
+
current_creditor_other?: EligibilityDebtAccountCurrentCreditorOther;
|
|
2818
3307
|
/** Creditor name */
|
|
2819
3308
|
creditor_name?: string;
|
|
2820
3309
|
/** Account type */
|
|
2821
3310
|
account_type?: string;
|
|
2822
3311
|
/** Last 4 digits or masked account number */
|
|
2823
3312
|
account_number?: string;
|
|
2824
|
-
/**
|
|
2825
|
-
|
|
2826
|
-
|
|
2827
|
-
*/
|
|
2828
|
-
account_condition?: string | null;
|
|
2829
|
-
} | null;
|
|
3313
|
+
/** Condition of the account */
|
|
3314
|
+
account_condition?: EligibilityDebtAccountAccountCondition;
|
|
3315
|
+
}
|
|
2830
3316
|
|
|
2831
3317
|
/**
|
|
2832
3318
|
* Generated by orval v7.21.0 🍺
|
|
2833
3319
|
* Do not edit manually.
|
|
2834
3320
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2835
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
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.
|
|
2836
3322
|
|
|
2837
|
-
**Published:** 2026-
|
|
2838
|
-
* OpenAPI spec version: 2026.
|
|
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;
|
|
3331
|
+
|
|
3332
|
+
/**
|
|
3333
|
+
* Generated by orval v7.21.0 🍺
|
|
3334
|
+
* Do not edit manually.
|
|
3335
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
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.
|
|
3337
|
+
|
|
3338
|
+
**Published:** 2026-10-30
|
|
3339
|
+
* OpenAPI spec version: 2026.21.0
|
|
2839
3340
|
*/
|
|
2840
3341
|
|
|
2841
3342
|
/**
|
|
@@ -2844,22 +3345,20 @@ type EligibilityDebtAccount = {
|
|
|
2844
3345
|
interface EligibilityRequest {
|
|
2845
3346
|
/** Whether to pull a live soft credit report. When false, debt_accounts must be provided instead. */
|
|
2846
3347
|
pull_credit_report: boolean;
|
|
3348
|
+
/** Applicant details. Only state is required when pull_credit_report is false. */
|
|
2847
3349
|
applicant?: EligibilityApplicant;
|
|
2848
|
-
/**
|
|
2849
|
-
|
|
2850
|
-
* @nullable
|
|
2851
|
-
*/
|
|
2852
|
-
debt_accounts?: EligibilityDebtAccount[] | null;
|
|
3350
|
+
/** Debt accounts to evaluate. Required when pull_credit_report is false. */
|
|
3351
|
+
debt_accounts?: EligibilityRequestDebtAccounts;
|
|
2853
3352
|
}
|
|
2854
3353
|
|
|
2855
3354
|
/**
|
|
2856
3355
|
* Generated by orval v7.21.0 🍺
|
|
2857
3356
|
* Do not edit manually.
|
|
2858
3357
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2859
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
2860
3359
|
|
|
2861
|
-
**Published:** 2026-
|
|
2862
|
-
* OpenAPI spec version: 2026.
|
|
3360
|
+
**Published:** 2026-10-30
|
|
3361
|
+
* OpenAPI spec version: 2026.21.0
|
|
2863
3362
|
*/
|
|
2864
3363
|
|
|
2865
3364
|
/**
|
|
@@ -2870,6 +3369,7 @@ interface EligibilityResponse {
|
|
|
2870
3369
|
id?: string;
|
|
2871
3370
|
/** Result message */
|
|
2872
3371
|
message?: string;
|
|
3372
|
+
/** Eligibility program data */
|
|
2873
3373
|
application?: EligibilityApplication;
|
|
2874
3374
|
}
|
|
2875
3375
|
|
|
@@ -2877,10 +3377,42 @@ interface EligibilityResponse {
|
|
|
2877
3377
|
* Generated by orval v7.21.0 🍺
|
|
2878
3378
|
* Do not edit manually.
|
|
2879
3379
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2880
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
2881
3381
|
|
|
2882
|
-
**Published:** 2026-
|
|
2883
|
-
* OpenAPI spec version: 2026.
|
|
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.
|
|
3413
|
+
|
|
3414
|
+
**Published:** 2026-10-30
|
|
3415
|
+
* OpenAPI spec version: 2026.21.0
|
|
2884
3416
|
*/
|
|
2885
3417
|
/**
|
|
2886
3418
|
* Address — used for current and mailing address updates
|
|
@@ -2902,10 +3434,10 @@ interface PatchAddress {
|
|
|
2902
3434
|
* Generated by orval v7.21.0 🍺
|
|
2903
3435
|
* Do not edit manually.
|
|
2904
3436
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2905
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
2906
3438
|
|
|
2907
|
-
**Published:** 2026-
|
|
2908
|
-
* OpenAPI spec version: 2026.
|
|
3439
|
+
**Published:** 2026-10-30
|
|
3440
|
+
* OpenAPI spec version: 2026.21.0
|
|
2909
3441
|
*/
|
|
2910
3442
|
|
|
2911
3443
|
/**
|
|
@@ -2928,7 +3460,9 @@ interface PatchApplicant {
|
|
|
2928
3460
|
mobile_phone_number?: string;
|
|
2929
3461
|
/** Applicant email address */
|
|
2930
3462
|
email?: string;
|
|
3463
|
+
/** Current residential address */
|
|
2931
3464
|
current_address?: PatchAddress;
|
|
3465
|
+
/** Mailing address (if different from current) */
|
|
2932
3466
|
mailing_address?: PatchAddress;
|
|
2933
3467
|
/** FDR applicant identifier */
|
|
2934
3468
|
fdr_applicant_id?: string;
|
|
@@ -2974,10 +3508,29 @@ interface PatchApplicant {
|
|
|
2974
3508
|
* Generated by orval v7.21.0 🍺
|
|
2975
3509
|
* Do not edit manually.
|
|
2976
3510
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2977
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
2978
3531
|
|
|
2979
|
-
**Published:** 2026-
|
|
2980
|
-
* OpenAPI spec version: 2026.
|
|
3532
|
+
**Published:** 2026-10-30
|
|
3533
|
+
* OpenAPI spec version: 2026.21.0
|
|
2981
3534
|
*/
|
|
2982
3535
|
/**
|
|
2983
3536
|
* Hardship category
|
|
@@ -2996,10 +3549,10 @@ declare const LeadPatchRequestHardshipCategory: {
|
|
|
2996
3549
|
* Generated by orval v7.21.0 🍺
|
|
2997
3550
|
* Do not edit manually.
|
|
2998
3551
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2999
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
3000
3553
|
|
|
3001
|
-
**Published:** 2026-
|
|
3002
|
-
* OpenAPI spec version: 2026.
|
|
3554
|
+
**Published:** 2026-10-30
|
|
3555
|
+
* OpenAPI spec version: 2026.21.0
|
|
3003
3556
|
*/
|
|
3004
3557
|
/**
|
|
3005
3558
|
* Goal category
|
|
@@ -3016,10 +3569,10 @@ declare const LeadPatchRequestGoalCategory: {
|
|
|
3016
3569
|
* Generated by orval v7.21.0 🍺
|
|
3017
3570
|
* Do not edit manually.
|
|
3018
3571
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3019
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
3020
3573
|
|
|
3021
|
-
**Published:** 2026-
|
|
3022
|
-
* OpenAPI spec version: 2026.
|
|
3574
|
+
**Published:** 2026-10-30
|
|
3575
|
+
* OpenAPI spec version: 2026.21.0
|
|
3023
3576
|
*/
|
|
3024
3577
|
/**
|
|
3025
3578
|
* Condition to verify (lead-level or debt-account-level)
|
|
@@ -3037,10 +3590,10 @@ interface PatchCondition {
|
|
|
3037
3590
|
* Generated by orval v7.21.0 🍺
|
|
3038
3591
|
* Do not edit manually.
|
|
3039
3592
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3040
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
3041
3594
|
|
|
3042
|
-
**Published:** 2026-
|
|
3043
|
-
* OpenAPI spec version: 2026.
|
|
3595
|
+
**Published:** 2026-10-30
|
|
3596
|
+
* OpenAPI spec version: 2026.21.0
|
|
3044
3597
|
*/
|
|
3045
3598
|
|
|
3046
3599
|
/**
|
|
@@ -3061,10 +3614,10 @@ interface PatchDebtAccount {
|
|
|
3061
3614
|
* Generated by orval v7.21.0 🍺
|
|
3062
3615
|
* Do not edit manually.
|
|
3063
3616
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3064
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
3065
3618
|
|
|
3066
|
-
**Published:** 2026-
|
|
3067
|
-
* OpenAPI spec version: 2026.
|
|
3619
|
+
**Published:** 2026-10-30
|
|
3620
|
+
* OpenAPI spec version: 2026.21.0
|
|
3068
3621
|
*/
|
|
3069
3622
|
/**
|
|
3070
3623
|
* Co-applicant fields that can be patched
|
|
@@ -3122,16 +3675,17 @@ interface PatchCoApplicant {
|
|
|
3122
3675
|
* Generated by orval v7.21.0 🍺
|
|
3123
3676
|
* Do not edit manually.
|
|
3124
3677
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3125
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
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.
|
|
3126
3679
|
|
|
3127
|
-
**Published:** 2026-
|
|
3128
|
-
* OpenAPI spec version: 2026.
|
|
3680
|
+
**Published:** 2026-10-30
|
|
3681
|
+
* OpenAPI spec version: 2026.21.0
|
|
3129
3682
|
*/
|
|
3130
3683
|
|
|
3131
3684
|
/**
|
|
3132
|
-
* 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.
|
|
3133
3686
|
*/
|
|
3134
3687
|
interface LeadPatchRequest {
|
|
3688
|
+
/** Applicant fields to update */
|
|
3135
3689
|
applicant?: PatchApplicant;
|
|
3136
3690
|
/** Whether the applicant owns or rents their home */
|
|
3137
3691
|
own_or_rent?: string;
|
|
@@ -3139,6 +3693,10 @@ interface LeadPatchRequest {
|
|
|
3139
3693
|
rent_or_mortgage_monthly?: number;
|
|
3140
3694
|
/** Desired monthly deposit amount */
|
|
3141
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;
|
|
3142
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. */
|
|
3143
3701
|
second_draft_date_split?: string;
|
|
3144
3702
|
/** Hardship category */
|
|
@@ -3219,6 +3777,7 @@ interface LeadPatchRequest {
|
|
|
3219
3777
|
conditions?: PatchCondition[];
|
|
3220
3778
|
/** Debt accounts with condition updates */
|
|
3221
3779
|
debt_accounts?: PatchDebtAccount[];
|
|
3780
|
+
/** Co-applicant fields to update */
|
|
3222
3781
|
co_applicant?: PatchCoApplicant;
|
|
3223
3782
|
}
|
|
3224
3783
|
|
|
@@ -3226,39 +3785,77 @@ interface LeadPatchRequest {
|
|
|
3226
3785
|
* Generated by orval v7.21.0 🍺
|
|
3227
3786
|
* Do not edit manually.
|
|
3228
3787
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3229
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
3230
3789
|
|
|
3231
|
-
**Published:** 2026-
|
|
3232
|
-
* OpenAPI spec version: 2026.
|
|
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.
|
|
3817
|
+
|
|
3818
|
+
**Published:** 2026-10-30
|
|
3819
|
+
* OpenAPI spec version: 2026.21.0
|
|
3233
3820
|
*/
|
|
3234
3821
|
|
|
3235
3822
|
/**
|
|
3236
3823
|
* Program readiness evaluation result (UW Submission response only)
|
|
3237
|
-
* @nullable
|
|
3238
3824
|
*/
|
|
3239
|
-
|
|
3825
|
+
interface LeadReadiness {
|
|
3240
3826
|
/** Array of readiness check results */
|
|
3241
3827
|
checks?: Check[];
|
|
3242
|
-
/**
|
|
3243
|
-
|
|
3244
|
-
|
|
3245
|
-
|
|
3246
|
-
|
|
3247
|
-
|
|
3248
|
-
|
|
3249
|
-
|
|
3250
|
-
|
|
3251
|
-
|
|
3252
|
-
|
|
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;
|
|
3253
3850
|
|
|
3254
3851
|
/**
|
|
3255
3852
|
* Generated by orval v7.21.0 🍺
|
|
3256
3853
|
* Do not edit manually.
|
|
3257
3854
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3258
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
3259
3856
|
|
|
3260
|
-
**Published:** 2026-
|
|
3261
|
-
* OpenAPI spec version: 2026.
|
|
3857
|
+
**Published:** 2026-10-30
|
|
3858
|
+
* OpenAPI spec version: 2026.21.0
|
|
3262
3859
|
*/
|
|
3263
3860
|
|
|
3264
3861
|
/**
|
|
@@ -3269,18 +3866,22 @@ interface LeadResponse {
|
|
|
3269
3866
|
id?: string;
|
|
3270
3867
|
/** Result message */
|
|
3271
3868
|
message?: string;
|
|
3869
|
+
/** Transformed program data */
|
|
3272
3870
|
application?: LeadApplication;
|
|
3273
|
-
|
|
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;
|
|
3274
3875
|
}
|
|
3275
3876
|
|
|
3276
3877
|
/**
|
|
3277
3878
|
* Generated by orval v7.21.0 🍺
|
|
3278
3879
|
* Do not edit manually.
|
|
3279
3880
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3280
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
3281
3882
|
|
|
3282
|
-
**Published:** 2026-
|
|
3283
|
-
* OpenAPI spec version: 2026.
|
|
3883
|
+
**Published:** 2026-10-30
|
|
3884
|
+
* OpenAPI spec version: 2026.21.0
|
|
3284
3885
|
*/
|
|
3285
3886
|
/**
|
|
3286
3887
|
* Applicant mailing address.
|
|
@@ -3300,10 +3901,10 @@ interface MailingAddress {
|
|
|
3300
3901
|
* Generated by orval v7.21.0 🍺
|
|
3301
3902
|
* Do not edit manually.
|
|
3302
3903
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3303
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
3304
3905
|
|
|
3305
|
-
**Published:** 2026-
|
|
3306
|
-
* OpenAPI spec version: 2026.
|
|
3906
|
+
**Published:** 2026-10-30
|
|
3907
|
+
* OpenAPI spec version: 2026.21.0
|
|
3307
3908
|
*/
|
|
3308
3909
|
/**
|
|
3309
3910
|
* Marketing tracking metadata
|
|
@@ -3321,10 +3922,10 @@ interface Tracking {
|
|
|
3321
3922
|
* Generated by orval v7.21.0 🍺
|
|
3322
3923
|
* Do not edit manually.
|
|
3323
3924
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3324
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
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.
|
|
3325
3926
|
|
|
3326
|
-
**Published:** 2026-
|
|
3327
|
-
* OpenAPI spec version: 2026.
|
|
3927
|
+
**Published:** 2026-10-30
|
|
3928
|
+
* OpenAPI spec version: 2026.21.0
|
|
3328
3929
|
*/
|
|
3329
3930
|
|
|
3330
3931
|
/**
|
|
@@ -3347,8 +3948,11 @@ interface LeadTransferRequest {
|
|
|
3347
3948
|
unsecured_debt?: number;
|
|
3348
3949
|
/** Social Security Number in SSN format (e.g. 123-45-6789). Optional. */
|
|
3349
3950
|
social_security_number?: string;
|
|
3951
|
+
/** Applicant mailing address */
|
|
3350
3952
|
mailing_address?: MailingAddress;
|
|
3953
|
+
/** Marketing and tracking metadata */
|
|
3351
3954
|
tracking?: Tracking;
|
|
3955
|
+
/** Regulatory and platform consent strings */
|
|
3352
3956
|
consents?: Consents;
|
|
3353
3957
|
}
|
|
3354
3958
|
|
|
@@ -3356,10 +3960,52 @@ interface LeadTransferRequest {
|
|
|
3356
3960
|
* Generated by orval v7.21.0 🍺
|
|
3357
3961
|
* Do not edit manually.
|
|
3358
3962
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3359
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
3360
3978
|
|
|
3361
|
-
**Published:** 2026-
|
|
3362
|
-
* OpenAPI spec version: 2026.
|
|
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.
|
|
4006
|
+
|
|
4007
|
+
**Published:** 2026-10-30
|
|
4008
|
+
* OpenAPI spec version: 2026.21.0
|
|
3363
4009
|
*/
|
|
3364
4010
|
/**
|
|
3365
4011
|
* Evaluation outcome: 'accepted' or 'rejected'.
|
|
@@ -3374,55 +4020,68 @@ declare const LeadTransferResponseResponse: {
|
|
|
3374
4020
|
* Generated by orval v7.21.0 🍺
|
|
3375
4021
|
* Do not edit manually.
|
|
3376
4022
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3377
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
3378
4024
|
|
|
3379
|
-
**Published:** 2026-
|
|
3380
|
-
* OpenAPI spec version: 2026.
|
|
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.
|
|
4052
|
+
|
|
4053
|
+
**Published:** 2026-10-30
|
|
4054
|
+
* OpenAPI spec version: 2026.21.0
|
|
3381
4055
|
*/
|
|
3382
4056
|
|
|
3383
4057
|
/**
|
|
3384
4058
|
* Lead evaluation result. Field presence varies between accepted and rejected outcomes.
|
|
3385
4059
|
*/
|
|
3386
4060
|
interface LeadTransferResponse {
|
|
3387
|
-
/**
|
|
3388
|
-
|
|
3389
|
-
|
|
3390
|
-
|
|
3391
|
-
|
|
3392
|
-
|
|
3393
|
-
* ISO-8601 timestamp when the evaluation was created. Present on accepted leads.
|
|
3394
|
-
* @nullable
|
|
3395
|
-
*/
|
|
3396
|
-
created_at?: string | null;
|
|
3397
|
-
/**
|
|
3398
|
-
* ISO-8601 timestamp when the evaluation was last updated. Present on accepted leads.
|
|
3399
|
-
* @nullable
|
|
3400
|
-
*/
|
|
3401
|
-
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;
|
|
3402
4067
|
/** Evaluation outcome: 'accepted' or 'rejected'. */
|
|
3403
4068
|
response?: LeadTransferResponseResponse;
|
|
3404
4069
|
/** Redirect URL for the applicant to view offers. */
|
|
3405
4070
|
get_offers_url?: string;
|
|
3406
|
-
/**
|
|
3407
|
-
|
|
3408
|
-
|
|
3409
|
-
|
|
3410
|
-
response_reason?: string | null;
|
|
3411
|
-
/**
|
|
3412
|
-
* Human-readable rejection detail messages. Present on rejected leads. May be a plain string or an array of strings.
|
|
3413
|
-
* @nullable
|
|
3414
|
-
*/
|
|
3415
|
-
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;
|
|
3416
4075
|
}
|
|
3417
4076
|
|
|
3418
4077
|
/**
|
|
3419
4078
|
* Generated by orval v7.21.0 🍺
|
|
3420
4079
|
* Do not edit manually.
|
|
3421
4080
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3422
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
3423
4082
|
|
|
3424
|
-
**Published:** 2026-
|
|
3425
|
-
* OpenAPI spec version: 2026.
|
|
4083
|
+
**Published:** 2026-10-30
|
|
4084
|
+
* OpenAPI spec version: 2026.21.0
|
|
3426
4085
|
*/
|
|
3427
4086
|
/**
|
|
3428
4087
|
* Request body for async program generation (v1)
|
|
@@ -3438,10 +4097,10 @@ interface ProgramRequest {
|
|
|
3438
4097
|
* Generated by orval v7.21.0 🍺
|
|
3439
4098
|
* Do not edit manually.
|
|
3440
4099
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3441
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
3442
4101
|
|
|
3443
|
-
**Published:** 2026-
|
|
3444
|
-
* OpenAPI spec version: 2026.
|
|
4102
|
+
**Published:** 2026-10-30
|
|
4103
|
+
* OpenAPI spec version: 2026.21.0
|
|
3445
4104
|
*/
|
|
3446
4105
|
/**
|
|
3447
4106
|
* Minimal applicant reference identifying the lead
|
|
@@ -3457,10 +4116,10 @@ interface ProgramSelectionApplicant {
|
|
|
3457
4116
|
* Generated by orval v7.21.0 🍺
|
|
3458
4117
|
* Do not edit manually.
|
|
3459
4118
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3460
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
3461
4120
|
|
|
3462
|
-
**Published:** 2026-
|
|
3463
|
-
* OpenAPI spec version: 2026.
|
|
4121
|
+
**Published:** 2026-10-30
|
|
4122
|
+
* OpenAPI spec version: 2026.21.0
|
|
3464
4123
|
*/
|
|
3465
4124
|
/**
|
|
3466
4125
|
* Selected draft schedule type from payment_schedule_options
|
|
@@ -3476,16 +4135,17 @@ declare const ProgramSelectionRequestDraftType: {
|
|
|
3476
4135
|
* Generated by orval v7.21.0 🍺
|
|
3477
4136
|
* Do not edit manually.
|
|
3478
4137
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3479
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
3480
4139
|
|
|
3481
|
-
**Published:** 2026-
|
|
3482
|
-
* OpenAPI spec version: 2026.
|
|
4140
|
+
**Published:** 2026-10-30
|
|
4141
|
+
* OpenAPI spec version: 2026.21.0
|
|
3483
4142
|
*/
|
|
3484
4143
|
|
|
3485
4144
|
/**
|
|
3486
4145
|
* Request body for selecting a payment schedule for an existing lead
|
|
3487
4146
|
*/
|
|
3488
4147
|
interface ProgramSelectionRequest {
|
|
4148
|
+
/** Applicant reference identifying the lead to update */
|
|
3489
4149
|
applicant: ProgramSelectionApplicant;
|
|
3490
4150
|
/** Selected draft schedule type from payment_schedule_options */
|
|
3491
4151
|
draft_type?: ProgramSelectionRequestDraftType;
|
|
@@ -3497,10 +4157,10 @@ interface ProgramSelectionRequest {
|
|
|
3497
4157
|
* Generated by orval v7.21.0 🍺
|
|
3498
4158
|
* Do not edit manually.
|
|
3499
4159
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3500
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
3501
4161
|
|
|
3502
|
-
**Published:** 2026-
|
|
3503
|
-
* OpenAPI spec version: 2026.
|
|
4162
|
+
**Published:** 2026-10-30
|
|
4163
|
+
* OpenAPI spec version: 2026.21.0
|
|
3504
4164
|
*/
|
|
3505
4165
|
/**
|
|
3506
4166
|
* Request body for creating a Program Summary Recording task (RWA-2427)
|
|
@@ -3524,10 +4184,10 @@ interface ProgramSummaryTaskRequest {
|
|
|
3524
4184
|
* Generated by orval v7.21.0 🍺
|
|
3525
4185
|
* Do not edit manually.
|
|
3526
4186
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3527
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
3528
4188
|
|
|
3529
|
-
**Published:** 2026-
|
|
3530
|
-
* OpenAPI spec version: 2026.
|
|
4189
|
+
**Published:** 2026-10-30
|
|
4190
|
+
* OpenAPI spec version: 2026.21.0
|
|
3531
4191
|
*/
|
|
3532
4192
|
/**
|
|
3533
4193
|
* Response body for a successfully created Program Summary Recording task
|
|
@@ -3551,10 +4211,38 @@ interface ProgramSummaryTaskResponse {
|
|
|
3551
4211
|
* Generated by orval v7.21.0 🍺
|
|
3552
4212
|
* Do not edit manually.
|
|
3553
4213
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3554
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
3555
4215
|
|
|
3556
|
-
**Published:** 2026-
|
|
3557
|
-
* OpenAPI spec version: 2026.
|
|
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.
|
|
4243
|
+
|
|
4244
|
+
**Published:** 2026-10-30
|
|
4245
|
+
* OpenAPI spec version: 2026.21.0
|
|
3558
4246
|
*/
|
|
3559
4247
|
|
|
3560
4248
|
/**
|
|
@@ -3563,26 +4251,20 @@ interface ProgramSummaryTaskResponse {
|
|
|
3563
4251
|
interface ReadinessResponse {
|
|
3564
4252
|
/** Array of individual readiness check results */
|
|
3565
4253
|
checks?: ReadinessCheck[];
|
|
3566
|
-
/**
|
|
3567
|
-
|
|
3568
|
-
|
|
3569
|
-
|
|
3570
|
-
is_program_refresh_required?: boolean | null;
|
|
3571
|
-
/**
|
|
3572
|
-
* Whether UW has previously approved this application
|
|
3573
|
-
* @nullable
|
|
3574
|
-
*/
|
|
3575
|
-
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;
|
|
3576
4258
|
}
|
|
3577
4259
|
|
|
3578
4260
|
/**
|
|
3579
4261
|
* Generated by orval v7.21.0 🍺
|
|
3580
4262
|
* Do not edit manually.
|
|
3581
4263
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3582
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
3583
4265
|
|
|
3584
|
-
**Published:** 2026-
|
|
3585
|
-
* OpenAPI spec version: 2026.
|
|
4266
|
+
**Published:** 2026-10-30
|
|
4267
|
+
* OpenAPI spec version: 2026.21.0
|
|
3586
4268
|
*/
|
|
3587
4269
|
|
|
3588
4270
|
/**
|
|
@@ -3591,6 +4273,7 @@ interface ReadinessResponse {
|
|
|
3591
4273
|
interface RegisterApplicantV2Request {
|
|
3592
4274
|
/** Email of the seller agent to be set as the Salesforce record owner */
|
|
3593
4275
|
seller_agent_email?: string;
|
|
4276
|
+
/** Applicant details to register */
|
|
3594
4277
|
applicant: Applicant;
|
|
3595
4278
|
}
|
|
3596
4279
|
|
|
@@ -3598,10 +4281,10 @@ interface RegisterApplicantV2Request {
|
|
|
3598
4281
|
* Generated by orval v7.21.0 🍺
|
|
3599
4282
|
* Do not edit manually.
|
|
3600
4283
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3601
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
3602
4285
|
|
|
3603
|
-
**Published:** 2026-
|
|
3604
|
-
* OpenAPI spec version: 2026.
|
|
4286
|
+
**Published:** 2026-10-30
|
|
4287
|
+
* OpenAPI spec version: 2026.21.0
|
|
3605
4288
|
*/
|
|
3606
4289
|
/**
|
|
3607
4290
|
* Response returned after successfully registering an applicant via POST /v2/applicant/register
|
|
@@ -3621,10 +4304,10 @@ interface RegisterApplicantV2Response {
|
|
|
3621
4304
|
* Generated by orval v7.21.0 🍺
|
|
3622
4305
|
* Do not edit manually.
|
|
3623
4306
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3624
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
3625
4308
|
|
|
3626
|
-
**Published:** 2026-
|
|
3627
|
-
* OpenAPI spec version: 2026.
|
|
4309
|
+
**Published:** 2026-10-30
|
|
4310
|
+
* OpenAPI spec version: 2026.21.0
|
|
3628
4311
|
*/
|
|
3629
4312
|
|
|
3630
4313
|
/**
|
|
@@ -3641,6 +4324,7 @@ interface SpinwheelNetworkUserRequest {
|
|
|
3641
4324
|
network_user_token: string;
|
|
3642
4325
|
/** Applicant date of birth (ISO-8601) */
|
|
3643
4326
|
date_of_birth: string;
|
|
4327
|
+
/** Audit metadata including user consent date */
|
|
3644
4328
|
audit: AuditInfo;
|
|
3645
4329
|
}
|
|
3646
4330
|
|
|
@@ -3648,10 +4332,10 @@ interface SpinwheelNetworkUserRequest {
|
|
|
3648
4332
|
* Generated by orval v7.21.0 🍺
|
|
3649
4333
|
* Do not edit manually.
|
|
3650
4334
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3651
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
3652
4336
|
|
|
3653
|
-
**Published:** 2026-
|
|
3654
|
-
* OpenAPI spec version: 2026.
|
|
4337
|
+
**Published:** 2026-10-30
|
|
4338
|
+
* OpenAPI spec version: 2026.21.0
|
|
3655
4339
|
*/
|
|
3656
4340
|
/**
|
|
3657
4341
|
* Result of creating or connecting a Spinwheel network user
|
|
@@ -3667,10 +4351,10 @@ interface SpinwheelNetworkUserResponse {
|
|
|
3667
4351
|
* Generated by orval v7.21.0 🍺
|
|
3668
4352
|
* Do not edit manually.
|
|
3669
4353
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3670
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
3671
4355
|
|
|
3672
|
-
**Published:** 2026-
|
|
3673
|
-
* OpenAPI spec version: 2026.
|
|
4356
|
+
**Published:** 2026-10-30
|
|
4357
|
+
* OpenAPI spec version: 2026.21.0
|
|
3674
4358
|
*/
|
|
3675
4359
|
/**
|
|
3676
4360
|
* Primary hardship category
|
|
@@ -3689,10 +4373,10 @@ declare const StatelessReadinessRequestHardshipCategory: {
|
|
|
3689
4373
|
* Generated by orval v7.21.0 🍺
|
|
3690
4374
|
* Do not edit manually.
|
|
3691
4375
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3692
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
3693
4377
|
|
|
3694
|
-
**Published:** 2026-
|
|
3695
|
-
* OpenAPI spec version: 2026.
|
|
4378
|
+
**Published:** 2026-10-30
|
|
4379
|
+
* OpenAPI spec version: 2026.21.0
|
|
3696
4380
|
*/
|
|
3697
4381
|
/**
|
|
3698
4382
|
* Primary goal category
|
|
@@ -3709,10 +4393,10 @@ declare const StatelessReadinessRequestGoalCategory: {
|
|
|
3709
4393
|
* Generated by orval v7.21.0 🍺
|
|
3710
4394
|
* Do not edit manually.
|
|
3711
4395
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3712
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
3713
4397
|
|
|
3714
|
-
**Published:** 2026-
|
|
3715
|
-
* OpenAPI spec version: 2026.
|
|
4398
|
+
**Published:** 2026-10-30
|
|
4399
|
+
* OpenAPI spec version: 2026.21.0
|
|
3716
4400
|
*/
|
|
3717
4401
|
|
|
3718
4402
|
/**
|
|
@@ -3837,6 +4521,7 @@ interface StatelessReadinessRequest {
|
|
|
3837
4521
|
program_time_savings_vs_minimum_payments?: number;
|
|
3838
4522
|
/** Program payment options (3 tiers) */
|
|
3839
4523
|
payment_options?: PaymentOption[];
|
|
4524
|
+
/** Primary applicant details */
|
|
3840
4525
|
applicant?: LeadApplicantInput;
|
|
3841
4526
|
/** List of debt accounts submitted for readiness evaluation */
|
|
3842
4527
|
debt_accounts?: DebtAccount[];
|
|
@@ -3848,10 +4533,10 @@ interface StatelessReadinessRequest {
|
|
|
3848
4533
|
* Generated by orval v7.21.0 🍺
|
|
3849
4534
|
* Do not edit manually.
|
|
3850
4535
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3851
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
3852
4537
|
|
|
3853
|
-
**Published:** 2026-
|
|
3854
|
-
* OpenAPI spec version: 2026.
|
|
4538
|
+
**Published:** 2026-10-30
|
|
4539
|
+
* OpenAPI spec version: 2026.21.0
|
|
3855
4540
|
*/
|
|
3856
4541
|
/**
|
|
3857
4542
|
* Thin applicant projection returned within UW Submission V2
|
|
@@ -3877,10 +4562,10 @@ interface UwSubmissionV2Applicant {
|
|
|
3877
4562
|
* Generated by orval v7.21.0 🍺
|
|
3878
4563
|
* Do not edit manually.
|
|
3879
4564
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3880
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
3881
4566
|
|
|
3882
|
-
**Published:** 2026-
|
|
3883
|
-
* OpenAPI spec version: 2026.
|
|
4567
|
+
**Published:** 2026-10-30
|
|
4568
|
+
* OpenAPI spec version: 2026.21.0
|
|
3884
4569
|
*/
|
|
3885
4570
|
|
|
3886
4571
|
/**
|
|
@@ -3889,6 +4574,7 @@ interface UwSubmissionV2Applicant {
|
|
|
3889
4574
|
interface UwSubmissionV2Application {
|
|
3890
4575
|
/** Application language */
|
|
3891
4576
|
language?: string;
|
|
4577
|
+
/** Applicant identity and contact projection */
|
|
3892
4578
|
applicant?: UwSubmissionV2Applicant;
|
|
3893
4579
|
/** Application conditions */
|
|
3894
4580
|
conditions?: LeadCondition[];
|
|
@@ -3920,10 +4606,24 @@ interface UwSubmissionV2Application {
|
|
|
3920
4606
|
* Generated by orval v7.21.0 🍺
|
|
3921
4607
|
* Do not edit manually.
|
|
3922
4608
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3923
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant'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.
|
|
3924
4624
|
|
|
3925
|
-
**Published:** 2026-
|
|
3926
|
-
* OpenAPI spec version: 2026.
|
|
4625
|
+
**Published:** 2026-10-30
|
|
4626
|
+
* OpenAPI spec version: 2026.21.0
|
|
3927
4627
|
*/
|
|
3928
4628
|
|
|
3929
4629
|
/**
|
|
@@ -3934,15 +4634,14 @@ interface UwSubmissionV2Response {
|
|
|
3934
4634
|
id?: string;
|
|
3935
4635
|
/** Result message */
|
|
3936
4636
|
message?: string;
|
|
4637
|
+
/** Thin application projection returned by UW Submission V2 */
|
|
3937
4638
|
application?: UwSubmissionV2Application;
|
|
4639
|
+
/** Readiness checks returned with the UW submission response */
|
|
3938
4640
|
readiness?: LeadReadiness;
|
|
3939
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). */
|
|
3940
4642
|
banking_disclosure_email_sent?: boolean;
|
|
3941
|
-
/**
|
|
3942
|
-
|
|
3943
|
-
* @nullable
|
|
3944
|
-
*/
|
|
3945
|
-
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;
|
|
3946
4645
|
}
|
|
3947
4646
|
|
|
3948
4647
|
/**
|
|
@@ -3959,9 +4658,8 @@ interface UwSubmissionV2Response {
|
|
|
3959
4658
|
* The two *vocabularies* remain — a corrected enum is not a unified one.
|
|
3960
4659
|
*
|
|
3961
4660
|
* Scope is narrow: `LeadApplication.draft_type` is the only label-valued site
|
|
3962
|
-
* in the whole spec. `
|
|
3963
|
-
*
|
|
3964
|
-
* `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`.
|
|
3965
4663
|
*
|
|
3966
4664
|
* These maps are annotated as `Record<>` over the generated enums on purpose:
|
|
3967
4665
|
* if FDR ever adds a fourth draft type, codegen widens the enum and these fail
|
|
@@ -4026,26 +4724,27 @@ declare const draftTypeOf: (application: LeadApplication | undefined | null) =>
|
|
|
4026
4724
|
declare class ArpcSDK {
|
|
4027
4725
|
/** The full typed endpoint surface — one method per gateway operation. */
|
|
4028
4726
|
readonly api: {
|
|
4029
|
-
|
|
4030
|
-
selectProgram: (programSelectionRequest: ProgramSelectionRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<LeadResponse>>;
|
|
4031
|
-
checkApplicationReadiness: (statelessReadinessRequest: StatelessReadinessRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<ReadinessResponse>>;
|
|
4032
|
-
createSpinwheelNetworkUser: (spinwheelNetworkUserRequest: SpinwheelNetworkUserRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<SpinwheelNetworkUserResponse>>;
|
|
4033
|
-
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>>;
|
|
4034
4728
|
sendEmail: (fdrApplicantId: string, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<ApplicationSendEmailResponse>>;
|
|
4035
4729
|
leadTransfer: (leadTransferRequest: LeadTransferRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<LeadTransferResponse>>;
|
|
4730
|
+
createLeadSync: (createLeadRequest: CreateLeadRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<CreateLeadResponse>>;
|
|
4036
4731
|
readLead: (fdrApplicantId: string, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<LeadResponse>>;
|
|
4037
4732
|
patchLead: (fdrApplicantId: string, leadPatchRequest: LeadPatchRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<LeadResponse>>;
|
|
4038
|
-
|
|
4039
|
-
|
|
4040
|
-
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>>;
|
|
4041
4735
|
generateProgramV1: (programRequest: ProgramRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<LeadResponse>>;
|
|
4042
4736
|
checkEligibility: (eligibilityRequest: EligibilityRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<EligibilityResponse>>;
|
|
4043
|
-
|
|
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>>;
|
|
4044
4742
|
createProgramSummaryTask: (id: string, programSummaryTaskRequest: ProgramSummaryTaskRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<ProgramSummaryTaskResponse>>;
|
|
4743
|
+
uwSubmissionV2: (fdrApplicantId: string, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<UwSubmissionV2Response>>;
|
|
4045
4744
|
resendAgreement: (fdrApplicantId: string, envelopeId: string, agreementResendRequest: AgreementResendRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<DraResponse>>;
|
|
4046
4745
|
voidAgreement: (fdrApplicantId: string, envelopeId: string, agreementVoidRequest: AgreementVoidRequest, options?: Partial<RequestConfig> | undefined) => Promise<HttpResponse<AgreementVoidResponse>>;
|
|
4047
4746
|
};
|
|
4048
4747
|
constructor(config: ArpcConfig);
|
|
4049
4748
|
}
|
|
4050
4749
|
|
|
4051
|
-
export { type ARPCErrorResponse, 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, 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 };
|