@borrowbetter/arpcsdk 0.4.0 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -8
- package/dist/index.d.mts +421 -370
- package/dist/index.d.ts +421 -370
- package/dist/index.js.map +1 -1
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -90,8 +90,8 @@ interface ArpcConfig {
|
|
|
90
90
|
* ARPC — Achieve Resolution Partner Connect API
|
|
91
91
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
92
92
|
|
|
93
|
-
**Published:** 2026-08-
|
|
94
|
-
* OpenAPI spec version: 2026.16.
|
|
93
|
+
**Published:** 2026-08-18
|
|
94
|
+
* OpenAPI spec version: 2026.16.1
|
|
95
95
|
*/
|
|
96
96
|
/**
|
|
97
97
|
* Stable machine-readable reason for the violation. See ValidationReasonCode.
|
|
@@ -112,8 +112,8 @@ declare const FieldValidationErrorReasonCode: {
|
|
|
112
112
|
* ARPC — Achieve Resolution Partner Connect API
|
|
113
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.
|
|
114
114
|
|
|
115
|
-
**Published:** 2026-08-
|
|
116
|
-
* OpenAPI spec version: 2026.16.
|
|
115
|
+
**Published:** 2026-08-18
|
|
116
|
+
* OpenAPI spec version: 2026.16.1
|
|
117
117
|
*/
|
|
118
118
|
|
|
119
119
|
/**
|
|
@@ -134,8 +134,139 @@ interface FieldValidationError {
|
|
|
134
134
|
* ARPC — Achieve Resolution Partner Connect API
|
|
135
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.
|
|
136
136
|
|
|
137
|
-
**Published:** 2026-08-
|
|
138
|
-
* OpenAPI spec version: 2026.16.
|
|
137
|
+
**Published:** 2026-08-18
|
|
138
|
+
* OpenAPI spec version: 2026.16.1
|
|
139
|
+
*/
|
|
140
|
+
/**
|
|
141
|
+
* Check type identifier
|
|
142
|
+
*/
|
|
143
|
+
type ReadinessCheckType = typeof ReadinessCheckType[keyof typeof ReadinessCheckType];
|
|
144
|
+
declare const ReadinessCheckType: {
|
|
145
|
+
readonly lead: "lead";
|
|
146
|
+
readonly uw_submission: "uw_submission";
|
|
147
|
+
readonly dra: "dra";
|
|
148
|
+
readonly readiness: "readiness";
|
|
149
|
+
};
|
|
150
|
+
|
|
151
|
+
/**
|
|
152
|
+
* Generated by orval v7.21.0 🍺
|
|
153
|
+
* Do not edit manually.
|
|
154
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
155
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
156
|
+
|
|
157
|
+
**Published:** 2026-08-18
|
|
158
|
+
* OpenAPI spec version: 2026.16.1
|
|
159
|
+
*/
|
|
160
|
+
/**
|
|
161
|
+
* Stable machine-readable code you can safely branch on.
|
|
162
|
+
*/
|
|
163
|
+
type ReadinessErrorDetailReasonCode = typeof ReadinessErrorDetailReasonCode[keyof typeof ReadinessErrorDetailReasonCode];
|
|
164
|
+
declare const ReadinessErrorDetailReasonCode: {
|
|
165
|
+
readonly REQUIRED: "REQUIRED";
|
|
166
|
+
readonly DUPLICATE_EMAIL: "DUPLICATE_EMAIL";
|
|
167
|
+
readonly HARDSHIP_CHECK_FAILED: "HARDSHIP_CHECK_FAILED";
|
|
168
|
+
readonly PO_BOX_NOT_ALLOWED: "PO_BOX_NOT_ALLOWED";
|
|
169
|
+
readonly DEBT_ACCOUNTS_MISSING: "DEBT_ACCOUNTS_MISSING";
|
|
170
|
+
readonly MEDICAL_DEBT_INVALID: "MEDICAL_DEBT_INVALID";
|
|
171
|
+
readonly MANUAL_DEBT_INVALID: "MANUAL_DEBT_INVALID";
|
|
172
|
+
readonly DEBT_TOTAL_MISMATCH: "DEBT_TOTAL_MISMATCH";
|
|
173
|
+
readonly PROGRAM_START_DATE_INVALID: "PROGRAM_START_DATE_INVALID";
|
|
174
|
+
readonly CONDITION_NOT_VERIFIED: "CONDITION_NOT_VERIFIED";
|
|
175
|
+
readonly PROVISIONAL_DEBT_ABOVE_THRESHOLD: "PROVISIONAL_DEBT_ABOVE_THRESHOLD";
|
|
176
|
+
};
|
|
177
|
+
|
|
178
|
+
/**
|
|
179
|
+
* Generated by orval v7.21.0 🍺
|
|
180
|
+
* Do not edit manually.
|
|
181
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
182
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
183
|
+
|
|
184
|
+
**Published:** 2026-08-18
|
|
185
|
+
* OpenAPI spec version: 2026.16.1
|
|
186
|
+
*/
|
|
187
|
+
|
|
188
|
+
/**
|
|
189
|
+
* Structured failure entry within a readiness check
|
|
190
|
+
* @nullable
|
|
191
|
+
*/
|
|
192
|
+
type ReadinessErrorDetail = {
|
|
193
|
+
/**
|
|
194
|
+
* Dotted JSON path of the input field that caused the failure (snake_case). Omitted when the failure is not tied to a specific field.
|
|
195
|
+
* @nullable
|
|
196
|
+
*/
|
|
197
|
+
field?: string | null;
|
|
198
|
+
/** Stable machine-readable code you can safely branch on. */
|
|
199
|
+
reason_code?: ReadinessErrorDetailReasonCode;
|
|
200
|
+
/** Human-readable explanation — same text as in errors[]. May be reworded over time; do not match on this value. */
|
|
201
|
+
message?: string;
|
|
202
|
+
} | null;
|
|
203
|
+
|
|
204
|
+
/**
|
|
205
|
+
* Generated by orval v7.21.0 🍺
|
|
206
|
+
* Do not edit manually.
|
|
207
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
208
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
209
|
+
|
|
210
|
+
**Published:** 2026-08-18
|
|
211
|
+
* OpenAPI spec version: 2026.16.1
|
|
212
|
+
*/
|
|
213
|
+
|
|
214
|
+
/**
|
|
215
|
+
* Individual readiness check result
|
|
216
|
+
*/
|
|
217
|
+
interface ReadinessCheck {
|
|
218
|
+
/** Check type identifier */
|
|
219
|
+
type?: ReadinessCheckType;
|
|
220
|
+
/** Whether this check passed */
|
|
221
|
+
verified?: boolean;
|
|
222
|
+
/**
|
|
223
|
+
* Validation error messages if the check failed
|
|
224
|
+
* @nullable
|
|
225
|
+
*/
|
|
226
|
+
errors?: (string | null)[] | null;
|
|
227
|
+
/**
|
|
228
|
+
* Structured failure entries for this check. Present only when the check fails. Prefer this over errors[] for programmatic handling — reason_code is stable and safe to branch on. errors[] is kept for backwards compatibility.
|
|
229
|
+
* @nullable
|
|
230
|
+
*/
|
|
231
|
+
error_details?: ReadinessErrorDetail[] | null;
|
|
232
|
+
}
|
|
233
|
+
|
|
234
|
+
/**
|
|
235
|
+
* Generated by orval v7.21.0 🍺
|
|
236
|
+
* Do not edit manually.
|
|
237
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
238
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
239
|
+
|
|
240
|
+
**Published:** 2026-08-18
|
|
241
|
+
* OpenAPI spec version: 2026.16.1
|
|
242
|
+
*/
|
|
243
|
+
|
|
244
|
+
/**
|
|
245
|
+
* Readiness check breakdown
|
|
246
|
+
* @nullable
|
|
247
|
+
*/
|
|
248
|
+
type ErrorDetails = {
|
|
249
|
+
/** Per-gate check results */
|
|
250
|
+
checks?: ReadinessCheck[];
|
|
251
|
+
/**
|
|
252
|
+
* Summary message for the readiness failure
|
|
253
|
+
* @nullable
|
|
254
|
+
*/
|
|
255
|
+
message?: string | null;
|
|
256
|
+
/** Whether a program refresh is required before re-submission */
|
|
257
|
+
is_program_refresh_required?: boolean;
|
|
258
|
+
/** Whether the application is currently UW-approved */
|
|
259
|
+
is_uw_approved?: boolean;
|
|
260
|
+
} | null;
|
|
261
|
+
|
|
262
|
+
/**
|
|
263
|
+
* Generated by orval v7.21.0 🍺
|
|
264
|
+
* Do not edit manually.
|
|
265
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
266
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
267
|
+
|
|
268
|
+
**Published:** 2026-08-18
|
|
269
|
+
* OpenAPI spec version: 2026.16.1
|
|
139
270
|
*/
|
|
140
271
|
|
|
141
272
|
/**
|
|
@@ -150,6 +281,7 @@ interface ARPCErrorResponse {
|
|
|
150
281
|
error?: string;
|
|
151
282
|
/** Field-level violations. Present only for field-validation failures (e.g. ER40001, ER00400); absent for upstream, auth, or internal errors. */
|
|
152
283
|
errors?: FieldValidationError[];
|
|
284
|
+
error_details?: ErrorDetails;
|
|
153
285
|
/** Free-text reason for non-field-validation failures (upstream rejection, auth failure, internal error). Absent when 'errors[]' is populated. */
|
|
154
286
|
message?: string;
|
|
155
287
|
/** ISO-8601 UTC timestamp of when the error occurred */
|
|
@@ -164,8 +296,8 @@ interface ARPCErrorResponse {
|
|
|
164
296
|
* ARPC — Achieve Resolution Partner Connect API
|
|
165
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.
|
|
166
298
|
|
|
167
|
-
**Published:** 2026-08-
|
|
168
|
-
* OpenAPI spec version: 2026.16.
|
|
299
|
+
**Published:** 2026-08-18
|
|
300
|
+
* OpenAPI spec version: 2026.16.1
|
|
169
301
|
*/
|
|
170
302
|
/**
|
|
171
303
|
* Street address
|
|
@@ -189,8 +321,8 @@ interface Address {
|
|
|
189
321
|
* ARPC — Achieve Resolution Partner Connect API
|
|
190
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.
|
|
191
323
|
|
|
192
|
-
**Published:** 2026-08-
|
|
193
|
-
* OpenAPI spec version: 2026.16.
|
|
324
|
+
**Published:** 2026-08-18
|
|
325
|
+
* OpenAPI spec version: 2026.16.1
|
|
194
326
|
*/
|
|
195
327
|
/**
|
|
196
328
|
* Address used by v2. ZIP is exposed as zip_code on the public request.
|
|
@@ -214,8 +346,8 @@ interface RegisterApplicantV2Address {
|
|
|
214
346
|
* ARPC — Achieve Resolution Partner Connect API
|
|
215
347
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
216
348
|
|
|
217
|
-
**Published:** 2026-08-
|
|
218
|
-
* OpenAPI spec version: 2026.16.
|
|
349
|
+
**Published:** 2026-08-18
|
|
350
|
+
* OpenAPI spec version: 2026.16.1
|
|
219
351
|
*/
|
|
220
352
|
|
|
221
353
|
/**
|
|
@@ -257,8 +389,8 @@ interface Applicant {
|
|
|
257
389
|
* ARPC — Achieve Resolution Partner Connect API
|
|
258
390
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
259
391
|
|
|
260
|
-
**Published:** 2026-08-
|
|
261
|
-
* OpenAPI spec version: 2026.16.
|
|
392
|
+
**Published:** 2026-08-18
|
|
393
|
+
* OpenAPI spec version: 2026.16.1
|
|
262
394
|
*/
|
|
263
395
|
interface ApplicationSendEmailResponse {
|
|
264
396
|
status?: string;
|
|
@@ -273,8 +405,8 @@ interface ApplicationSendEmailResponse {
|
|
|
273
405
|
* ARPC — Achieve Resolution Partner Connect API
|
|
274
406
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
275
407
|
|
|
276
|
-
**Published:** 2026-08-
|
|
277
|
-
* OpenAPI spec version: 2026.16.
|
|
408
|
+
**Published:** 2026-08-18
|
|
409
|
+
* OpenAPI spec version: 2026.16.1
|
|
278
410
|
*/
|
|
279
411
|
/**
|
|
280
412
|
* Audit metadata
|
|
@@ -290,8 +422,8 @@ interface AuditInfo {
|
|
|
290
422
|
* ARPC — Achieve Resolution Partner Connect API
|
|
291
423
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
292
424
|
|
|
293
|
-
**Published:** 2026-08-
|
|
294
|
-
* OpenAPI spec version: 2026.16.
|
|
425
|
+
**Published:** 2026-08-18
|
|
426
|
+
* OpenAPI spec version: 2026.16.1
|
|
295
427
|
*/
|
|
296
428
|
/**
|
|
297
429
|
* Account type
|
|
@@ -308,8 +440,8 @@ declare const BankDetailsAccountType: {
|
|
|
308
440
|
* ARPC — Achieve Resolution Partner Connect API
|
|
309
441
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
310
442
|
|
|
311
|
-
**Published:** 2026-08-
|
|
312
|
-
* OpenAPI spec version: 2026.16.
|
|
443
|
+
**Published:** 2026-08-18
|
|
444
|
+
* OpenAPI spec version: 2026.16.1
|
|
313
445
|
*/
|
|
314
446
|
/**
|
|
315
447
|
* Account sub-type
|
|
@@ -326,8 +458,8 @@ declare const BankDetailsAccountSubtype: {
|
|
|
326
458
|
* ARPC — Achieve Resolution Partner Connect API
|
|
327
459
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
328
460
|
|
|
329
|
-
**Published:** 2026-08-
|
|
330
|
-
* OpenAPI spec version: 2026.16.
|
|
461
|
+
**Published:** 2026-08-18
|
|
462
|
+
* OpenAPI spec version: 2026.16.1
|
|
331
463
|
*/
|
|
332
464
|
|
|
333
465
|
/**
|
|
@@ -368,8 +500,8 @@ type BankDetails = {
|
|
|
368
500
|
* ARPC — Achieve Resolution Partner Connect API
|
|
369
501
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
370
502
|
|
|
371
|
-
**Published:** 2026-08-
|
|
372
|
-
* OpenAPI spec version: 2026.16.
|
|
503
|
+
**Published:** 2026-08-18
|
|
504
|
+
* OpenAPI spec version: 2026.16.1
|
|
373
505
|
*/
|
|
374
506
|
/**
|
|
375
507
|
* Bank account input fields
|
|
@@ -387,8 +519,8 @@ interface BankDetailsInput {
|
|
|
387
519
|
* ARPC — Achieve Resolution Partner Connect API
|
|
388
520
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
389
521
|
|
|
390
|
-
**Published:** 2026-08-
|
|
391
|
-
* OpenAPI spec version: 2026.16.
|
|
522
|
+
**Published:** 2026-08-18
|
|
523
|
+
* OpenAPI spec version: 2026.16.1
|
|
392
524
|
*/
|
|
393
525
|
|
|
394
526
|
/**
|
|
@@ -408,8 +540,8 @@ interface BankUpdateRequest {
|
|
|
408
540
|
* ARPC — Achieve Resolution Partner Connect API
|
|
409
541
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
410
542
|
|
|
411
|
-
**Published:** 2026-08-
|
|
412
|
-
* OpenAPI spec version: 2026.16.
|
|
543
|
+
**Published:** 2026-08-18
|
|
544
|
+
* OpenAPI spec version: 2026.16.1
|
|
413
545
|
*/
|
|
414
546
|
/**
|
|
415
547
|
* Check type identifier
|
|
@@ -426,8 +558,8 @@ declare const CheckType: {
|
|
|
426
558
|
* ARPC — Achieve Resolution Partner Connect API
|
|
427
559
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
428
560
|
|
|
429
|
-
**Published:** 2026-08-
|
|
430
|
-
* OpenAPI spec version: 2026.16.
|
|
561
|
+
**Published:** 2026-08-18
|
|
562
|
+
* OpenAPI spec version: 2026.16.1
|
|
431
563
|
*/
|
|
432
564
|
|
|
433
565
|
/**
|
|
@@ -443,6 +575,11 @@ interface Check {
|
|
|
443
575
|
* @nullable
|
|
444
576
|
*/
|
|
445
577
|
errors?: (string | null)[] | null;
|
|
578
|
+
/**
|
|
579
|
+
* Structured validation details for this readiness check
|
|
580
|
+
* @nullable
|
|
581
|
+
*/
|
|
582
|
+
error_details?: ReadinessErrorDetail[] | null;
|
|
446
583
|
}
|
|
447
584
|
|
|
448
585
|
/**
|
|
@@ -451,8 +588,8 @@ interface Check {
|
|
|
451
588
|
* ARPC — Achieve Resolution Partner Connect API
|
|
452
589
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
453
590
|
|
|
454
|
-
**Published:** 2026-08-
|
|
455
|
-
* OpenAPI spec version: 2026.16.
|
|
591
|
+
**Published:** 2026-08-18
|
|
592
|
+
* OpenAPI spec version: 2026.16.1
|
|
456
593
|
*/
|
|
457
594
|
|
|
458
595
|
/**
|
|
@@ -521,8 +658,8 @@ interface CoApplicant {
|
|
|
521
658
|
* ARPC — Achieve Resolution Partner Connect API
|
|
522
659
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
523
660
|
|
|
524
|
-
**Published:** 2026-08-
|
|
525
|
-
* OpenAPI spec version: 2026.16.
|
|
661
|
+
**Published:** 2026-08-18
|
|
662
|
+
* OpenAPI spec version: 2026.16.1
|
|
526
663
|
*/
|
|
527
664
|
/**
|
|
528
665
|
* Required consent strings for regulatory and platform compliance
|
|
@@ -546,8 +683,8 @@ interface Consents {
|
|
|
546
683
|
* ARPC — Achieve Resolution Partner Connect API
|
|
547
684
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
548
685
|
|
|
549
|
-
**Published:** 2026-08-
|
|
550
|
-
* OpenAPI spec version: 2026.16.
|
|
686
|
+
**Published:** 2026-08-18
|
|
687
|
+
* OpenAPI spec version: 2026.16.1
|
|
551
688
|
*/
|
|
552
689
|
/**
|
|
553
690
|
* Lead distribution routing configuration
|
|
@@ -565,8 +702,8 @@ interface LeadDistribution {
|
|
|
565
702
|
* ARPC — Achieve Resolution Partner Connect API
|
|
566
703
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
567
704
|
|
|
568
|
-
**Published:** 2026-08-
|
|
569
|
-
* OpenAPI spec version: 2026.16.
|
|
705
|
+
**Published:** 2026-08-18
|
|
706
|
+
* OpenAPI spec version: 2026.16.1
|
|
570
707
|
*/
|
|
571
708
|
/**
|
|
572
709
|
* Primary hardship category
|
|
@@ -587,8 +724,8 @@ declare const CreateLeadRequestHardshipCategory: {
|
|
|
587
724
|
* ARPC — Achieve Resolution Partner Connect API
|
|
588
725
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
589
726
|
|
|
590
|
-
**Published:** 2026-08-
|
|
591
|
-
* OpenAPI spec version: 2026.16.
|
|
727
|
+
**Published:** 2026-08-18
|
|
728
|
+
* OpenAPI spec version: 2026.16.1
|
|
592
729
|
*/
|
|
593
730
|
/**
|
|
594
731
|
* Primary goal category
|
|
@@ -607,8 +744,8 @@ declare const CreateLeadRequestGoalCategory: {
|
|
|
607
744
|
* ARPC — Achieve Resolution Partner Connect API
|
|
608
745
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
609
746
|
|
|
610
|
-
**Published:** 2026-08-
|
|
611
|
-
* OpenAPI spec version: 2026.16.
|
|
747
|
+
**Published:** 2026-08-18
|
|
748
|
+
* OpenAPI spec version: 2026.16.1
|
|
612
749
|
*/
|
|
613
750
|
|
|
614
751
|
/**
|
|
@@ -687,8 +824,8 @@ interface LeadApplicantInput {
|
|
|
687
824
|
* ARPC — Achieve Resolution Partner Connect API
|
|
688
825
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
689
826
|
|
|
690
|
-
**Published:** 2026-08-
|
|
691
|
-
* OpenAPI spec version: 2026.16.
|
|
827
|
+
**Published:** 2026-08-18
|
|
828
|
+
* OpenAPI spec version: 2026.16.1
|
|
692
829
|
*/
|
|
693
830
|
/**
|
|
694
831
|
* Whether the condition is currently active
|
|
@@ -705,8 +842,8 @@ declare const LeadConditionActive: {
|
|
|
705
842
|
* ARPC — Achieve Resolution Partner Connect API
|
|
706
843
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
707
844
|
|
|
708
|
-
**Published:** 2026-08-
|
|
709
|
-
* OpenAPI spec version: 2026.16.
|
|
845
|
+
**Published:** 2026-08-18
|
|
846
|
+
* OpenAPI spec version: 2026.16.1
|
|
710
847
|
*/
|
|
711
848
|
/**
|
|
712
849
|
* Condition type. soft-condition types omit the verified field in the response.
|
|
@@ -725,8 +862,8 @@ declare const LeadConditionType: {
|
|
|
725
862
|
* ARPC — Achieve Resolution Partner Connect API
|
|
726
863
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
727
864
|
|
|
728
|
-
**Published:** 2026-08-
|
|
729
|
-
* OpenAPI spec version: 2026.16.
|
|
865
|
+
**Published:** 2026-08-18
|
|
866
|
+
* OpenAPI spec version: 2026.16.1
|
|
730
867
|
*/
|
|
731
868
|
|
|
732
869
|
/**
|
|
@@ -764,8 +901,8 @@ type LeadCondition = {
|
|
|
764
901
|
* ARPC — Achieve Resolution Partner Connect API
|
|
765
902
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
766
903
|
|
|
767
|
-
**Published:** 2026-08-
|
|
768
|
-
* OpenAPI spec version: 2026.16.
|
|
904
|
+
**Published:** 2026-08-18
|
|
905
|
+
* OpenAPI spec version: 2026.16.1
|
|
769
906
|
*/
|
|
770
907
|
|
|
771
908
|
/**
|
|
@@ -844,8 +981,8 @@ interface DebtAccount {
|
|
|
844
981
|
* ARPC — Achieve Resolution Partner Connect API
|
|
845
982
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
846
983
|
|
|
847
|
-
**Published:** 2026-08-
|
|
848
|
-
* OpenAPI spec version: 2026.16.
|
|
984
|
+
**Published:** 2026-08-18
|
|
985
|
+
* OpenAPI spec version: 2026.16.1
|
|
849
986
|
*/
|
|
850
987
|
|
|
851
988
|
/**
|
|
@@ -992,8 +1129,8 @@ interface CreateLeadRequest {
|
|
|
992
1129
|
* ARPC — Achieve Resolution Partner Connect API
|
|
993
1130
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
994
1131
|
|
|
995
|
-
**Published:** 2026-08-
|
|
996
|
-
* OpenAPI spec version: 2026.16.
|
|
1132
|
+
**Published:** 2026-08-18
|
|
1133
|
+
* OpenAPI spec version: 2026.16.1
|
|
997
1134
|
*/
|
|
998
1135
|
/**
|
|
999
1136
|
* Current program / opportunity stage
|
|
@@ -1019,8 +1156,8 @@ declare const LeadApplicationStatus: {
|
|
|
1019
1156
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1020
1157
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1021
1158
|
|
|
1022
|
-
**Published:** 2026-08-
|
|
1023
|
-
* OpenAPI spec version: 2026.16.
|
|
1159
|
+
**Published:** 2026-08-18
|
|
1160
|
+
* OpenAPI spec version: 2026.16.1
|
|
1024
1161
|
*/
|
|
1025
1162
|
/**
|
|
1026
1163
|
* Client's preferred language
|
|
@@ -1037,8 +1174,8 @@ declare const LeadApplicationLanguage: {
|
|
|
1037
1174
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1038
1175
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1039
1176
|
|
|
1040
|
-
**Published:** 2026-08-
|
|
1041
|
-
* OpenAPI spec version: 2026.16.
|
|
1177
|
+
**Published:** 2026-08-18
|
|
1178
|
+
* OpenAPI spec version: 2026.16.1
|
|
1042
1179
|
*/
|
|
1043
1180
|
/**
|
|
1044
1181
|
* Bankruptcy status on file
|
|
@@ -1058,8 +1195,8 @@ declare const LeadApplicantBankruptcy: {
|
|
|
1058
1195
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1059
1196
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1060
1197
|
|
|
1061
|
-
**Published:** 2026-08-
|
|
1062
|
-
* OpenAPI spec version: 2026.16.
|
|
1198
|
+
**Published:** 2026-08-18
|
|
1199
|
+
* OpenAPI spec version: 2026.16.1
|
|
1063
1200
|
*/
|
|
1064
1201
|
/**
|
|
1065
1202
|
* Pay frequency
|
|
@@ -1081,8 +1218,8 @@ declare const LeadApplicantPayFrequency: {
|
|
|
1081
1218
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1082
1219
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1083
1220
|
|
|
1084
|
-
**Published:** 2026-08-
|
|
1085
|
-
* OpenAPI spec version: 2026.16.
|
|
1221
|
+
**Published:** 2026-08-18
|
|
1222
|
+
* OpenAPI spec version: 2026.16.1
|
|
1086
1223
|
*/
|
|
1087
1224
|
/**
|
|
1088
1225
|
* Current employment status
|
|
@@ -1103,8 +1240,8 @@ declare const LeadApplicantEmploymentStatus: {
|
|
|
1103
1240
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1104
1241
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1105
1242
|
|
|
1106
|
-
**Published:** 2026-08-
|
|
1107
|
-
* OpenAPI spec version: 2026.16.
|
|
1243
|
+
**Published:** 2026-08-18
|
|
1244
|
+
* OpenAPI spec version: 2026.16.1
|
|
1108
1245
|
*/
|
|
1109
1246
|
|
|
1110
1247
|
/**
|
|
@@ -1204,8 +1341,8 @@ type LeadApplicant = {
|
|
|
1204
1341
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1205
1342
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1206
1343
|
|
|
1207
|
-
**Published:** 2026-08-
|
|
1208
|
-
* OpenAPI spec version: 2026.16.
|
|
1344
|
+
**Published:** 2026-08-18
|
|
1345
|
+
* OpenAPI spec version: 2026.16.1
|
|
1209
1346
|
*/
|
|
1210
1347
|
/**
|
|
1211
1348
|
* Sub-status of the current stage
|
|
@@ -1274,8 +1411,8 @@ declare const LeadApplicationSubStatus: {
|
|
|
1274
1411
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1275
1412
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1276
1413
|
|
|
1277
|
-
**Published:** 2026-08-
|
|
1278
|
-
* OpenAPI spec version: 2026.16.
|
|
1414
|
+
**Published:** 2026-08-18
|
|
1415
|
+
* OpenAPI spec version: 2026.16.1
|
|
1279
1416
|
*/
|
|
1280
1417
|
/**
|
|
1281
1418
|
* Indicates whether the program is FDR or CSS serviced
|
|
@@ -1292,13 +1429,11 @@ declare const LeadApplicationFdrOrCss: {
|
|
|
1292
1429
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1293
1430
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1294
1431
|
|
|
1295
|
-
**Published:** 2026-08-
|
|
1296
|
-
* OpenAPI spec version: 2026.16.
|
|
1432
|
+
**Published:** 2026-08-18
|
|
1433
|
+
* OpenAPI spec version: 2026.16.1
|
|
1297
1434
|
*/
|
|
1298
1435
|
/**
|
|
1299
|
-
* Draft frequency type
|
|
1300
|
-
|
|
1301
|
-
⚠️ Patched locally by `openapi/repairs.ts` — this differs from FDR's published spec.
|
|
1436
|
+
* Draft frequency type
|
|
1302
1437
|
*/
|
|
1303
1438
|
type LeadApplicationDraftType = typeof LeadApplicationDraftType[keyof typeof LeadApplicationDraftType];
|
|
1304
1439
|
declare const LeadApplicationDraftType: {
|
|
@@ -1313,8 +1448,8 @@ declare const LeadApplicationDraftType: {
|
|
|
1313
1448
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1314
1449
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1315
1450
|
|
|
1316
|
-
**Published:** 2026-08-
|
|
1317
|
-
* OpenAPI spec version: 2026.16.
|
|
1451
|
+
**Published:** 2026-08-18
|
|
1452
|
+
* OpenAPI spec version: 2026.16.1
|
|
1318
1453
|
*/
|
|
1319
1454
|
/**
|
|
1320
1455
|
* Whether client is on fixed income. Salesforce returns this as the string \"Yes\" or \"No\" (not a boolean).
|
|
@@ -1331,8 +1466,8 @@ declare const LeadApplicationFixedIncome: {
|
|
|
1331
1466
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1332
1467
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1333
1468
|
|
|
1334
|
-
**Published:** 2026-08-
|
|
1335
|
-
* OpenAPI spec version: 2026.16.
|
|
1469
|
+
**Published:** 2026-08-18
|
|
1470
|
+
* OpenAPI spec version: 2026.16.1
|
|
1336
1471
|
*/
|
|
1337
1472
|
/**
|
|
1338
1473
|
* Whether the client owns or rents their home
|
|
@@ -1349,8 +1484,8 @@ declare const LeadApplicationOwnOrRent: {
|
|
|
1349
1484
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1350
1485
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1351
1486
|
|
|
1352
|
-
**Published:** 2026-08-
|
|
1353
|
-
* OpenAPI spec version: 2026.16.
|
|
1487
|
+
**Published:** 2026-08-18
|
|
1488
|
+
* OpenAPI spec version: 2026.16.1
|
|
1354
1489
|
*/
|
|
1355
1490
|
/**
|
|
1356
1491
|
* Primary hardship category
|
|
@@ -1371,8 +1506,8 @@ declare const LeadApplicationHardshipCategory: {
|
|
|
1371
1506
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1372
1507
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1373
1508
|
|
|
1374
|
-
**Published:** 2026-08-
|
|
1375
|
-
* OpenAPI spec version: 2026.16.
|
|
1509
|
+
**Published:** 2026-08-18
|
|
1510
|
+
* OpenAPI spec version: 2026.16.1
|
|
1376
1511
|
*/
|
|
1377
1512
|
/**
|
|
1378
1513
|
* Client's primary financial goal category
|
|
@@ -1391,8 +1526,8 @@ declare const LeadApplicationGoalCategory: {
|
|
|
1391
1526
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1392
1527
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1393
1528
|
|
|
1394
|
-
**Published:** 2026-08-
|
|
1395
|
-
* OpenAPI spec version: 2026.16.
|
|
1529
|
+
**Published:** 2026-08-18
|
|
1530
|
+
* OpenAPI spec version: 2026.16.1
|
|
1396
1531
|
*/
|
|
1397
1532
|
/**
|
|
1398
1533
|
* Client's secondary financial goal
|
|
@@ -1415,8 +1550,8 @@ declare const LeadApplicationSecondaryGoal: {
|
|
|
1415
1550
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1416
1551
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1417
1552
|
|
|
1418
|
-
**Published:** 2026-08-
|
|
1419
|
-
* OpenAPI spec version: 2026.16.
|
|
1553
|
+
**Published:** 2026-08-18
|
|
1554
|
+
* OpenAPI spec version: 2026.16.1
|
|
1420
1555
|
*/
|
|
1421
1556
|
/**
|
|
1422
1557
|
* Source of the credit report pull (also present inside applicant)
|
|
@@ -1433,8 +1568,8 @@ declare const LeadApplicationCreditPullSource: {
|
|
|
1433
1568
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1434
1569
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1435
1570
|
|
|
1436
|
-
**Published:** 2026-08-
|
|
1437
|
-
* OpenAPI spec version: 2026.16.
|
|
1571
|
+
**Published:** 2026-08-18
|
|
1572
|
+
* OpenAPI spec version: 2026.16.1
|
|
1438
1573
|
*/
|
|
1439
1574
|
/**
|
|
1440
1575
|
* Creditor or original creditor details
|
|
@@ -1472,8 +1607,8 @@ interface LeadCreditor {
|
|
|
1472
1607
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1473
1608
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1474
1609
|
|
|
1475
|
-
**Published:** 2026-08-
|
|
1476
|
-
* OpenAPI spec version: 2026.16.
|
|
1610
|
+
**Published:** 2026-08-18
|
|
1611
|
+
* OpenAPI spec version: 2026.16.1
|
|
1477
1612
|
*/
|
|
1478
1613
|
/**
|
|
1479
1614
|
* Responsibility type for the account
|
|
@@ -1498,8 +1633,8 @@ declare const LeadDebtAccountResponsibility: {
|
|
|
1498
1633
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1499
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.
|
|
1500
1635
|
|
|
1501
|
-
**Published:** 2026-08-
|
|
1502
|
-
* OpenAPI spec version: 2026.16.
|
|
1636
|
+
**Published:** 2026-08-18
|
|
1637
|
+
* OpenAPI spec version: 2026.16.1
|
|
1503
1638
|
*/
|
|
1504
1639
|
/**
|
|
1505
1640
|
* Ownership of the account
|
|
@@ -1517,8 +1652,8 @@ declare const LeadDebtAccountOwnership: {
|
|
|
1517
1652
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1518
1653
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1519
1654
|
|
|
1520
|
-
**Published:** 2026-08-
|
|
1521
|
-
* OpenAPI spec version: 2026.16.
|
|
1655
|
+
**Published:** 2026-08-18
|
|
1656
|
+
* OpenAPI spec version: 2026.16.1
|
|
1522
1657
|
*/
|
|
1523
1658
|
/**
|
|
1524
1659
|
* Source of the debt account record
|
|
@@ -1538,8 +1673,8 @@ declare const LeadDebtAccountSource: {
|
|
|
1538
1673
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1539
1674
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1540
1675
|
|
|
1541
|
-
**Published:** 2026-08-
|
|
1542
|
-
* OpenAPI spec version: 2026.16.
|
|
1676
|
+
**Published:** 2026-08-18
|
|
1677
|
+
* OpenAPI spec version: 2026.16.1
|
|
1543
1678
|
*/
|
|
1544
1679
|
/**
|
|
1545
1680
|
* Type of account
|
|
@@ -1574,8 +1709,8 @@ declare const LeadDebtAccountAccountType: {
|
|
|
1574
1709
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1575
1710
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1576
1711
|
|
|
1577
|
-
**Published:** 2026-08-
|
|
1578
|
-
* OpenAPI spec version: 2026.16.
|
|
1712
|
+
**Published:** 2026-08-18
|
|
1713
|
+
* OpenAPI spec version: 2026.16.1
|
|
1579
1714
|
*/
|
|
1580
1715
|
/**
|
|
1581
1716
|
* Ineligibility reason identifier (PS_Id__c from PS_Evaluations_Config__mdt). See PgIneligibleReasonId for the full set of known values.
|
|
@@ -1613,8 +1748,8 @@ declare const IneligibleReasonReasonId: {
|
|
|
1613
1748
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1614
1749
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1615
1750
|
|
|
1616
|
-
**Published:** 2026-08-
|
|
1617
|
-
* OpenAPI spec version: 2026.16.
|
|
1751
|
+
**Published:** 2026-08-18
|
|
1752
|
+
* OpenAPI spec version: 2026.16.1
|
|
1618
1753
|
*/
|
|
1619
1754
|
|
|
1620
1755
|
/**
|
|
@@ -1632,8 +1767,8 @@ type IneligibleReason = {
|
|
|
1632
1767
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1633
1768
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1634
1769
|
|
|
1635
|
-
**Published:** 2026-08-
|
|
1636
|
-
* OpenAPI spec version: 2026.16.
|
|
1770
|
+
**Published:** 2026-08-18
|
|
1771
|
+
* OpenAPI spec version: 2026.16.1
|
|
1637
1772
|
*/
|
|
1638
1773
|
|
|
1639
1774
|
/**
|
|
@@ -1763,8 +1898,8 @@ interface LeadDebtAccount {
|
|
|
1763
1898
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1764
1899
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1765
1900
|
|
|
1766
|
-
**Published:** 2026-08-
|
|
1767
|
-
* OpenAPI spec version: 2026.16.
|
|
1901
|
+
**Published:** 2026-08-18
|
|
1902
|
+
* OpenAPI spec version: 2026.16.1
|
|
1768
1903
|
*/
|
|
1769
1904
|
/**
|
|
1770
1905
|
* Tier label for this payment option
|
|
@@ -1783,8 +1918,8 @@ declare const PaymentOptionEvaluationType: {
|
|
|
1783
1918
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1784
1919
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1785
1920
|
|
|
1786
|
-
**Published:** 2026-08-
|
|
1787
|
-
* OpenAPI spec version: 2026.16.
|
|
1921
|
+
**Published:** 2026-08-18
|
|
1922
|
+
* OpenAPI spec version: 2026.16.1
|
|
1788
1923
|
*/
|
|
1789
1924
|
|
|
1790
1925
|
/**
|
|
@@ -1811,8 +1946,8 @@ type PaymentOption = {
|
|
|
1811
1946
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1812
1947
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1813
1948
|
|
|
1814
|
-
**Published:** 2026-08-
|
|
1815
|
-
* OpenAPI spec version: 2026.16.
|
|
1949
|
+
**Published:** 2026-08-18
|
|
1950
|
+
* OpenAPI spec version: 2026.16.1
|
|
1816
1951
|
*/
|
|
1817
1952
|
/**
|
|
1818
1953
|
* Draft frequency type
|
|
@@ -1830,8 +1965,8 @@ declare const PaymentScheduleDraftType: {
|
|
|
1830
1965
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1831
1966
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1832
1967
|
|
|
1833
|
-
**Published:** 2026-08-
|
|
1834
|
-
* OpenAPI spec version: 2026.16.
|
|
1968
|
+
**Published:** 2026-08-18
|
|
1969
|
+
* OpenAPI spec version: 2026.16.1
|
|
1835
1970
|
*/
|
|
1836
1971
|
|
|
1837
1972
|
/**
|
|
@@ -1854,8 +1989,8 @@ interface PaymentSchedule {
|
|
|
1854
1989
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1855
1990
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1856
1991
|
|
|
1857
|
-
**Published:** 2026-08-
|
|
1858
|
-
* OpenAPI spec version: 2026.16.
|
|
1992
|
+
**Published:** 2026-08-18
|
|
1993
|
+
* OpenAPI spec version: 2026.16.1
|
|
1859
1994
|
*/
|
|
1860
1995
|
/**
|
|
1861
1996
|
* Tier label for this schedule option
|
|
@@ -1873,8 +2008,8 @@ declare const PaymentScheduleOptionEvaluationType: {
|
|
|
1873
2008
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1874
2009
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1875
2010
|
|
|
1876
|
-
**Published:** 2026-08-
|
|
1877
|
-
* OpenAPI spec version: 2026.16.
|
|
2011
|
+
**Published:** 2026-08-18
|
|
2012
|
+
* OpenAPI spec version: 2026.16.1
|
|
1878
2013
|
*/
|
|
1879
2014
|
|
|
1880
2015
|
/**
|
|
@@ -1900,8 +2035,8 @@ type PaymentScheduleOption = {
|
|
|
1900
2035
|
* ARPC — Achieve Resolution Partner Connect API
|
|
1901
2036
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
1902
2037
|
|
|
1903
|
-
**Published:** 2026-08-
|
|
1904
|
-
* OpenAPI spec version: 2026.16.
|
|
2038
|
+
**Published:** 2026-08-18
|
|
2039
|
+
* OpenAPI spec version: 2026.16.1
|
|
1905
2040
|
*/
|
|
1906
2041
|
|
|
1907
2042
|
/**
|
|
@@ -2030,9 +2165,7 @@ interface LeadApplication {
|
|
|
2030
2165
|
savings_vs_enrolled_debt?: number;
|
|
2031
2166
|
/** Monthly draft amount (USD) */
|
|
2032
2167
|
draft_amount?: number;
|
|
2033
|
-
/** Draft frequency type
|
|
2034
|
-
|
|
2035
|
-
⚠️ Patched locally by `openapi/repairs.ts` — this differs from FDR's published spec. */
|
|
2168
|
+
/** Draft frequency type */
|
|
2036
2169
|
draft_type?: LeadApplicationDraftType;
|
|
2037
2170
|
/** Date of first programme draft (YYYY-MM-DD) */
|
|
2038
2171
|
first_draft_date?: string;
|
|
@@ -2238,8 +2371,8 @@ interface LeadApplication {
|
|
|
2238
2371
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2239
2372
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2240
2373
|
|
|
2241
|
-
**Published:** 2026-08-
|
|
2242
|
-
* OpenAPI spec version: 2026.16.
|
|
2374
|
+
**Published:** 2026-08-18
|
|
2375
|
+
* OpenAPI spec version: 2026.16.1
|
|
2243
2376
|
*/
|
|
2244
2377
|
|
|
2245
2378
|
/**
|
|
@@ -2261,8 +2394,8 @@ interface CreateLeadResponse {
|
|
|
2261
2394
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2262
2395
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2263
2396
|
|
|
2264
|
-
**Published:** 2026-08-
|
|
2265
|
-
* OpenAPI spec version: 2026.16.
|
|
2397
|
+
**Published:** 2026-08-18
|
|
2398
|
+
* OpenAPI spec version: 2026.16.1
|
|
2266
2399
|
*/
|
|
2267
2400
|
/**
|
|
2268
2401
|
* Consent record for soft credit pull
|
|
@@ -2279,8 +2412,8 @@ type CreditPullConsent = {
|
|
|
2279
2412
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2280
2413
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2281
2414
|
|
|
2282
|
-
**Published:** 2026-08-
|
|
2283
|
-
* OpenAPI spec version: 2026.16.
|
|
2415
|
+
**Published:** 2026-08-18
|
|
2416
|
+
* OpenAPI spec version: 2026.16.1
|
|
2284
2417
|
*/
|
|
2285
2418
|
/**
|
|
2286
2419
|
* Applicant signing URL details
|
|
@@ -2296,8 +2429,8 @@ interface DraApplicant {
|
|
|
2296
2429
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2297
2430
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2298
2431
|
|
|
2299
|
-
**Published:** 2026-08-
|
|
2300
|
-
* OpenAPI spec version: 2026.16.
|
|
2432
|
+
**Published:** 2026-08-18
|
|
2433
|
+
* OpenAPI spec version: 2026.16.1
|
|
2301
2434
|
*/
|
|
2302
2435
|
/**
|
|
2303
2436
|
* DocuSign signing method. Use 'url' for embedded signing, 'email' for standard email signing.
|
|
@@ -2314,8 +2447,8 @@ declare const DraApplicantInputSigningType: {
|
|
|
2314
2447
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2315
2448
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2316
2449
|
|
|
2317
|
-
**Published:** 2026-08-
|
|
2318
|
-
* OpenAPI spec version: 2026.16.
|
|
2450
|
+
**Published:** 2026-08-18
|
|
2451
|
+
* OpenAPI spec version: 2026.16.1
|
|
2319
2452
|
*/
|
|
2320
2453
|
|
|
2321
2454
|
/**
|
|
@@ -2332,8 +2465,8 @@ interface DraApplicantInput {
|
|
|
2332
2465
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2333
2466
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2334
2467
|
|
|
2335
|
-
**Published:** 2026-08-
|
|
2336
|
-
* OpenAPI spec version: 2026.16.
|
|
2468
|
+
**Published:** 2026-08-18
|
|
2469
|
+
* OpenAPI spec version: 2026.16.1
|
|
2337
2470
|
*/
|
|
2338
2471
|
|
|
2339
2472
|
/**
|
|
@@ -2351,8 +2484,8 @@ interface DraRequest {
|
|
|
2351
2484
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2352
2485
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2353
2486
|
|
|
2354
|
-
**Published:** 2026-08-
|
|
2355
|
-
* OpenAPI spec version: 2026.16.
|
|
2487
|
+
**Published:** 2026-08-18
|
|
2488
|
+
* OpenAPI spec version: 2026.16.1
|
|
2356
2489
|
*/
|
|
2357
2490
|
|
|
2358
2491
|
/**
|
|
@@ -2370,8 +2503,8 @@ interface DraResponse {
|
|
|
2370
2503
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2371
2504
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2372
2505
|
|
|
2373
|
-
**Published:** 2026-08-
|
|
2374
|
-
* OpenAPI spec version: 2026.16.
|
|
2506
|
+
**Published:** 2026-08-18
|
|
2507
|
+
* OpenAPI spec version: 2026.16.1
|
|
2375
2508
|
*/
|
|
2376
2509
|
/**
|
|
2377
2510
|
* Address for eligibility request
|
|
@@ -2395,8 +2528,8 @@ interface EligibilityAddress {
|
|
|
2395
2528
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2396
2529
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2397
2530
|
|
|
2398
|
-
**Published:** 2026-08-
|
|
2399
|
-
* OpenAPI spec version: 2026.16.
|
|
2531
|
+
**Published:** 2026-08-18
|
|
2532
|
+
* OpenAPI spec version: 2026.16.1
|
|
2400
2533
|
*/
|
|
2401
2534
|
|
|
2402
2535
|
/**
|
|
@@ -2424,8 +2557,8 @@ interface EligibilityApplicant {
|
|
|
2424
2557
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2425
2558
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2426
2559
|
|
|
2427
|
-
**Published:** 2026-08-
|
|
2428
|
-
* OpenAPI spec version: 2026.16.
|
|
2560
|
+
**Published:** 2026-08-18
|
|
2561
|
+
* OpenAPI spec version: 2026.16.1
|
|
2429
2562
|
*/
|
|
2430
2563
|
|
|
2431
2564
|
/**
|
|
@@ -2510,8 +2643,8 @@ interface EligibilityApplication {
|
|
|
2510
2643
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2511
2644
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2512
2645
|
|
|
2513
|
-
**Published:** 2026-08-
|
|
2514
|
-
* OpenAPI spec version: 2026.16.
|
|
2646
|
+
**Published:** 2026-08-18
|
|
2647
|
+
* OpenAPI spec version: 2026.16.1
|
|
2515
2648
|
*/
|
|
2516
2649
|
/**
|
|
2517
2650
|
* Debt account entry for eligibility check (no-credit-pull path)
|
|
@@ -2552,8 +2685,8 @@ type EligibilityDebtAccount = {
|
|
|
2552
2685
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2553
2686
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2554
2687
|
|
|
2555
|
-
**Published:** 2026-08-
|
|
2556
|
-
* OpenAPI spec version: 2026.16.
|
|
2688
|
+
**Published:** 2026-08-18
|
|
2689
|
+
* OpenAPI spec version: 2026.16.1
|
|
2557
2690
|
*/
|
|
2558
2691
|
|
|
2559
2692
|
/**
|
|
@@ -2576,8 +2709,8 @@ interface EligibilityRequest {
|
|
|
2576
2709
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2577
2710
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2578
2711
|
|
|
2579
|
-
**Published:** 2026-08-
|
|
2580
|
-
* OpenAPI spec version: 2026.16.
|
|
2712
|
+
**Published:** 2026-08-18
|
|
2713
|
+
* OpenAPI spec version: 2026.16.1
|
|
2581
2714
|
*/
|
|
2582
2715
|
|
|
2583
2716
|
/**
|
|
@@ -2597,137 +2730,8 @@ interface EligibilityResponse {
|
|
|
2597
2730
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2598
2731
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2599
2732
|
|
|
2600
|
-
**Published:** 2026-08-
|
|
2601
|
-
* OpenAPI spec version: 2026.16.
|
|
2602
|
-
*/
|
|
2603
|
-
/**
|
|
2604
|
-
* Check type identifier
|
|
2605
|
-
*/
|
|
2606
|
-
type ReadinessCheckType = typeof ReadinessCheckType[keyof typeof ReadinessCheckType];
|
|
2607
|
-
declare const ReadinessCheckType: {
|
|
2608
|
-
readonly lead: "lead";
|
|
2609
|
-
readonly uw_submission: "uw_submission";
|
|
2610
|
-
readonly dra: "dra";
|
|
2611
|
-
readonly readiness: "readiness";
|
|
2612
|
-
};
|
|
2613
|
-
|
|
2614
|
-
/**
|
|
2615
|
-
* Generated by orval v7.21.0 🍺
|
|
2616
|
-
* Do not edit manually.
|
|
2617
|
-
* ARPC — Achieve Resolution Partner Connect API
|
|
2618
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2619
|
-
|
|
2620
|
-
**Published:** 2026-08-08
|
|
2621
|
-
* OpenAPI spec version: 2026.16.0
|
|
2622
|
-
*/
|
|
2623
|
-
/**
|
|
2624
|
-
* Stable machine-readable code you can safely branch on.
|
|
2625
|
-
*/
|
|
2626
|
-
type ReadinessErrorDetailReasonCode = typeof ReadinessErrorDetailReasonCode[keyof typeof ReadinessErrorDetailReasonCode];
|
|
2627
|
-
declare const ReadinessErrorDetailReasonCode: {
|
|
2628
|
-
readonly REQUIRED: "REQUIRED";
|
|
2629
|
-
readonly DUPLICATE_EMAIL: "DUPLICATE_EMAIL";
|
|
2630
|
-
readonly HARDSHIP_CHECK_FAILED: "HARDSHIP_CHECK_FAILED";
|
|
2631
|
-
readonly PO_BOX_NOT_ALLOWED: "PO_BOX_NOT_ALLOWED";
|
|
2632
|
-
readonly DEBT_ACCOUNTS_MISSING: "DEBT_ACCOUNTS_MISSING";
|
|
2633
|
-
readonly MEDICAL_DEBT_INVALID: "MEDICAL_DEBT_INVALID";
|
|
2634
|
-
readonly MANUAL_DEBT_INVALID: "MANUAL_DEBT_INVALID";
|
|
2635
|
-
readonly DEBT_TOTAL_MISMATCH: "DEBT_TOTAL_MISMATCH";
|
|
2636
|
-
readonly PROGRAM_START_DATE_INVALID: "PROGRAM_START_DATE_INVALID";
|
|
2637
|
-
readonly CONDITION_NOT_VERIFIED: "CONDITION_NOT_VERIFIED";
|
|
2638
|
-
readonly PROVISIONAL_DEBT_ABOVE_THRESHOLD: "PROVISIONAL_DEBT_ABOVE_THRESHOLD";
|
|
2639
|
-
};
|
|
2640
|
-
|
|
2641
|
-
/**
|
|
2642
|
-
* Generated by orval v7.21.0 🍺
|
|
2643
|
-
* Do not edit manually.
|
|
2644
|
-
* ARPC — Achieve Resolution Partner Connect API
|
|
2645
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2646
|
-
|
|
2647
|
-
**Published:** 2026-08-08
|
|
2648
|
-
* OpenAPI spec version: 2026.16.0
|
|
2649
|
-
*/
|
|
2650
|
-
|
|
2651
|
-
/**
|
|
2652
|
-
* Structured failure entry within a readiness check
|
|
2653
|
-
* @nullable
|
|
2654
|
-
*/
|
|
2655
|
-
type ReadinessErrorDetail = {
|
|
2656
|
-
/**
|
|
2657
|
-
* Dotted JSON path of the input field that caused the failure (snake_case). Omitted when the failure is not tied to a specific field.
|
|
2658
|
-
* @nullable
|
|
2659
|
-
*/
|
|
2660
|
-
field?: string | null;
|
|
2661
|
-
/** Stable machine-readable code you can safely branch on. */
|
|
2662
|
-
reason_code?: ReadinessErrorDetailReasonCode;
|
|
2663
|
-
/** Human-readable explanation — same text as in errors[]. May be reworded over time; do not match on this value. */
|
|
2664
|
-
message?: string;
|
|
2665
|
-
} | null;
|
|
2666
|
-
|
|
2667
|
-
/**
|
|
2668
|
-
* Generated by orval v7.21.0 🍺
|
|
2669
|
-
* Do not edit manually.
|
|
2670
|
-
* ARPC — Achieve Resolution Partner Connect API
|
|
2671
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2672
|
-
|
|
2673
|
-
**Published:** 2026-08-08
|
|
2674
|
-
* OpenAPI spec version: 2026.16.0
|
|
2675
|
-
*/
|
|
2676
|
-
|
|
2677
|
-
/**
|
|
2678
|
-
* Individual readiness check result
|
|
2679
|
-
*/
|
|
2680
|
-
interface ReadinessCheck {
|
|
2681
|
-
/** Check type identifier */
|
|
2682
|
-
type?: ReadinessCheckType;
|
|
2683
|
-
/** Whether this check passed */
|
|
2684
|
-
verified?: boolean;
|
|
2685
|
-
/**
|
|
2686
|
-
* Validation error messages if the check failed
|
|
2687
|
-
* @nullable
|
|
2688
|
-
*/
|
|
2689
|
-
errors?: (string | null)[] | null;
|
|
2690
|
-
/**
|
|
2691
|
-
* Structured failure entries for this check. Present only when the check fails. Prefer this over errors[] for programmatic handling — reason_code is stable and safe to branch on. errors[] is kept for backwards compatibility.
|
|
2692
|
-
* @nullable
|
|
2693
|
-
*/
|
|
2694
|
-
error_details?: ReadinessErrorDetail[] | null;
|
|
2695
|
-
}
|
|
2696
|
-
|
|
2697
|
-
/**
|
|
2698
|
-
* Generated by orval v7.21.0 🍺
|
|
2699
|
-
* Do not edit manually.
|
|
2700
|
-
* ARPC — Achieve Resolution Partner Connect API
|
|
2701
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2702
|
-
|
|
2703
|
-
**Published:** 2026-08-08
|
|
2704
|
-
* OpenAPI spec version: 2026.16.0
|
|
2705
|
-
*/
|
|
2706
|
-
|
|
2707
|
-
/**
|
|
2708
|
-
* Readiness check breakdown returned inside a gated error response.
|
|
2709
|
-
|
|
2710
|
-
⚠️ Patched locally by `openapi/repairs.ts` — this differs from FDR's published spec.
|
|
2711
|
-
*/
|
|
2712
|
-
interface ErrorDetails {
|
|
2713
|
-
/** Per-gate check results */
|
|
2714
|
-
checks?: ReadinessCheck[];
|
|
2715
|
-
/** Whether a program refresh is required before re-submission */
|
|
2716
|
-
is_program_refresh_required?: boolean;
|
|
2717
|
-
/** Whether the application is currently UW-approved */
|
|
2718
|
-
is_uw_approved?: boolean;
|
|
2719
|
-
/** Human-readable summary of the gate failure */
|
|
2720
|
-
message?: string;
|
|
2721
|
-
}
|
|
2722
|
-
|
|
2723
|
-
/**
|
|
2724
|
-
* Generated by orval v7.21.0 🍺
|
|
2725
|
-
* Do not edit manually.
|
|
2726
|
-
* ARPC — Achieve Resolution Partner Connect API
|
|
2727
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2728
|
-
|
|
2729
|
-
**Published:** 2026-08-08
|
|
2730
|
-
* OpenAPI spec version: 2026.16.0
|
|
2733
|
+
**Published:** 2026-08-18
|
|
2734
|
+
* OpenAPI spec version: 2026.16.1
|
|
2731
2735
|
*/
|
|
2732
2736
|
/**
|
|
2733
2737
|
* Address — used for current and mailing address updates
|
|
@@ -2751,8 +2755,8 @@ interface PatchAddress {
|
|
|
2751
2755
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2752
2756
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2753
2757
|
|
|
2754
|
-
**Published:** 2026-08-
|
|
2755
|
-
* OpenAPI spec version: 2026.16.
|
|
2758
|
+
**Published:** 2026-08-18
|
|
2759
|
+
* OpenAPI spec version: 2026.16.1
|
|
2756
2760
|
*/
|
|
2757
2761
|
|
|
2758
2762
|
/**
|
|
@@ -2823,8 +2827,8 @@ interface PatchApplicant {
|
|
|
2823
2827
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2824
2828
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2825
2829
|
|
|
2826
|
-
**Published:** 2026-08-
|
|
2827
|
-
* OpenAPI spec version: 2026.16.
|
|
2830
|
+
**Published:** 2026-08-18
|
|
2831
|
+
* OpenAPI spec version: 2026.16.1
|
|
2828
2832
|
*/
|
|
2829
2833
|
/**
|
|
2830
2834
|
* Hardship category
|
|
@@ -2845,8 +2849,8 @@ declare const LeadPatchRequestHardshipCategory: {
|
|
|
2845
2849
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2846
2850
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2847
2851
|
|
|
2848
|
-
**Published:** 2026-08-
|
|
2849
|
-
* OpenAPI spec version: 2026.16.
|
|
2852
|
+
**Published:** 2026-08-18
|
|
2853
|
+
* OpenAPI spec version: 2026.16.1
|
|
2850
2854
|
*/
|
|
2851
2855
|
/**
|
|
2852
2856
|
* Goal category
|
|
@@ -2865,8 +2869,8 @@ declare const LeadPatchRequestGoalCategory: {
|
|
|
2865
2869
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2866
2870
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2867
2871
|
|
|
2868
|
-
**Published:** 2026-08-
|
|
2869
|
-
* OpenAPI spec version: 2026.16.
|
|
2872
|
+
**Published:** 2026-08-18
|
|
2873
|
+
* OpenAPI spec version: 2026.16.1
|
|
2870
2874
|
*/
|
|
2871
2875
|
/**
|
|
2872
2876
|
* Condition to verify (lead-level or debt-account-level)
|
|
@@ -2886,8 +2890,8 @@ interface PatchCondition {
|
|
|
2886
2890
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2887
2891
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2888
2892
|
|
|
2889
|
-
**Published:** 2026-08-
|
|
2890
|
-
* OpenAPI spec version: 2026.16.
|
|
2893
|
+
**Published:** 2026-08-18
|
|
2894
|
+
* OpenAPI spec version: 2026.16.1
|
|
2891
2895
|
*/
|
|
2892
2896
|
|
|
2893
2897
|
/**
|
|
@@ -2910,8 +2914,8 @@ interface PatchDebtAccount {
|
|
|
2910
2914
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2911
2915
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2912
2916
|
|
|
2913
|
-
**Published:** 2026-08-
|
|
2914
|
-
* OpenAPI spec version: 2026.16.
|
|
2917
|
+
**Published:** 2026-08-18
|
|
2918
|
+
* OpenAPI spec version: 2026.16.1
|
|
2915
2919
|
*/
|
|
2916
2920
|
/**
|
|
2917
2921
|
* Co-applicant fields that can be patched
|
|
@@ -2971,8 +2975,8 @@ interface PatchCoApplicant {
|
|
|
2971
2975
|
* ARPC — Achieve Resolution Partner Connect API
|
|
2972
2976
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
2973
2977
|
|
|
2974
|
-
**Published:** 2026-08-
|
|
2975
|
-
* OpenAPI spec version: 2026.16.
|
|
2978
|
+
**Published:** 2026-08-18
|
|
2979
|
+
* OpenAPI spec version: 2026.16.1
|
|
2976
2980
|
*/
|
|
2977
2981
|
|
|
2978
2982
|
/**
|
|
@@ -2986,6 +2990,8 @@ interface LeadPatchRequest {
|
|
|
2986
2990
|
rent_or_mortgage_monthly?: number;
|
|
2987
2991
|
/** Desired monthly deposit amount */
|
|
2988
2992
|
monthly_deposit?: number;
|
|
2993
|
+
/** Second draft date for split (twice-monthly) drafts (YYYY-MM-DD). Set this after UW submission and before generating the DRA. For bi-weekly drafts, second_draft_date_bi_weekly is populated automatically during UW approval. */
|
|
2994
|
+
second_draft_date_split?: string;
|
|
2989
2995
|
/** Hardship category */
|
|
2990
2996
|
hardship_category?: LeadPatchRequestHardshipCategory;
|
|
2991
2997
|
/** Free-text hardship description when category is 'Other' */
|
|
@@ -3073,8 +3079,8 @@ interface LeadPatchRequest {
|
|
|
3073
3079
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3074
3080
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3075
3081
|
|
|
3076
|
-
**Published:** 2026-08-
|
|
3077
|
-
* OpenAPI spec version: 2026.16.
|
|
3082
|
+
**Published:** 2026-08-18
|
|
3083
|
+
* OpenAPI spec version: 2026.16.1
|
|
3078
3084
|
*/
|
|
3079
3085
|
|
|
3080
3086
|
/**
|
|
@@ -3102,8 +3108,8 @@ type LeadReadiness = {
|
|
|
3102
3108
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3103
3109
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3104
3110
|
|
|
3105
|
-
**Published:** 2026-08-
|
|
3106
|
-
* OpenAPI spec version: 2026.16.
|
|
3111
|
+
**Published:** 2026-08-18
|
|
3112
|
+
* OpenAPI spec version: 2026.16.1
|
|
3107
3113
|
*/
|
|
3108
3114
|
|
|
3109
3115
|
/**
|
|
@@ -3124,8 +3130,8 @@ interface LeadResponse {
|
|
|
3124
3130
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3125
3131
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3126
3132
|
|
|
3127
|
-
**Published:** 2026-08-
|
|
3128
|
-
* OpenAPI spec version: 2026.16.
|
|
3133
|
+
**Published:** 2026-08-18
|
|
3134
|
+
* OpenAPI spec version: 2026.16.1
|
|
3129
3135
|
*/
|
|
3130
3136
|
/**
|
|
3131
3137
|
* Applicant mailing address.
|
|
@@ -3147,8 +3153,8 @@ interface MailingAddress {
|
|
|
3147
3153
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3148
3154
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3149
3155
|
|
|
3150
|
-
**Published:** 2026-08-
|
|
3151
|
-
* OpenAPI spec version: 2026.16.
|
|
3156
|
+
**Published:** 2026-08-18
|
|
3157
|
+
* OpenAPI spec version: 2026.16.1
|
|
3152
3158
|
*/
|
|
3153
3159
|
/**
|
|
3154
3160
|
* Marketing tracking metadata
|
|
@@ -3168,8 +3174,8 @@ interface Tracking {
|
|
|
3168
3174
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3169
3175
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3170
3176
|
|
|
3171
|
-
**Published:** 2026-08-
|
|
3172
|
-
* OpenAPI spec version: 2026.16.
|
|
3177
|
+
**Published:** 2026-08-18
|
|
3178
|
+
* OpenAPI spec version: 2026.16.1
|
|
3173
3179
|
*/
|
|
3174
3180
|
|
|
3175
3181
|
/**
|
|
@@ -3203,8 +3209,8 @@ interface LeadTransferRequest {
|
|
|
3203
3209
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3204
3210
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3205
3211
|
|
|
3206
|
-
**Published:** 2026-08-
|
|
3207
|
-
* OpenAPI spec version: 2026.16.
|
|
3212
|
+
**Published:** 2026-08-18
|
|
3213
|
+
* OpenAPI spec version: 2026.16.1
|
|
3208
3214
|
*/
|
|
3209
3215
|
/**
|
|
3210
3216
|
* Evaluation outcome: 'accepted' or 'rejected'.
|
|
@@ -3221,8 +3227,8 @@ declare const LeadTransferResponseResponse: {
|
|
|
3221
3227
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3222
3228
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3223
3229
|
|
|
3224
|
-
**Published:** 2026-08-
|
|
3225
|
-
* OpenAPI spec version: 2026.16.
|
|
3230
|
+
**Published:** 2026-08-18
|
|
3231
|
+
* OpenAPI spec version: 2026.16.1
|
|
3226
3232
|
*/
|
|
3227
3233
|
|
|
3228
3234
|
/**
|
|
@@ -3266,8 +3272,8 @@ interface LeadTransferResponse {
|
|
|
3266
3272
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3267
3273
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3268
3274
|
|
|
3269
|
-
**Published:** 2026-08-
|
|
3270
|
-
* OpenAPI spec version: 2026.16.
|
|
3275
|
+
**Published:** 2026-08-18
|
|
3276
|
+
* OpenAPI spec version: 2026.16.1
|
|
3271
3277
|
*/
|
|
3272
3278
|
/**
|
|
3273
3279
|
* Request body for async program generation (v1)
|
|
@@ -3285,16 +3291,16 @@ interface ProgramRequest {
|
|
|
3285
3291
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3286
3292
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3287
3293
|
|
|
3288
|
-
**Published:** 2026-08-
|
|
3289
|
-
* OpenAPI spec version: 2026.16.
|
|
3294
|
+
**Published:** 2026-08-18
|
|
3295
|
+
* OpenAPI spec version: 2026.16.1
|
|
3290
3296
|
*/
|
|
3291
3297
|
/**
|
|
3292
|
-
*
|
|
3298
|
+
* Minimal applicant reference identifying the lead
|
|
3293
3299
|
|
|
3294
3300
|
⚠️ Patched locally by `openapi/repairs.ts` — this differs from FDR's published spec.
|
|
3295
3301
|
*/
|
|
3296
3302
|
interface ProgramSelectionApplicant {
|
|
3297
|
-
/** FDR applicant ID
|
|
3303
|
+
/** The unique FDR applicant ID of the lead */
|
|
3298
3304
|
fdr_applicant_id: string;
|
|
3299
3305
|
}
|
|
3300
3306
|
|
|
@@ -3304,8 +3310,8 @@ interface ProgramSelectionApplicant {
|
|
|
3304
3310
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3305
3311
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3306
3312
|
|
|
3307
|
-
**Published:** 2026-08-
|
|
3308
|
-
* OpenAPI spec version: 2026.16.
|
|
3313
|
+
**Published:** 2026-08-18
|
|
3314
|
+
* OpenAPI spec version: 2026.16.1
|
|
3309
3315
|
*/
|
|
3310
3316
|
/**
|
|
3311
3317
|
* Selected draft schedule type from payment_schedule_options
|
|
@@ -3323,8 +3329,8 @@ declare const ProgramSelectionRequestDraftType: {
|
|
|
3323
3329
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3324
3330
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3325
3331
|
|
|
3326
|
-
**Published:** 2026-08-
|
|
3327
|
-
* OpenAPI spec version: 2026.16.
|
|
3332
|
+
**Published:** 2026-08-18
|
|
3333
|
+
* OpenAPI spec version: 2026.16.1
|
|
3328
3334
|
*/
|
|
3329
3335
|
|
|
3330
3336
|
/**
|
|
@@ -3344,8 +3350,8 @@ interface ProgramSelectionRequest {
|
|
|
3344
3350
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3345
3351
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3346
3352
|
|
|
3347
|
-
**Published:** 2026-08-
|
|
3348
|
-
* OpenAPI spec version: 2026.16.
|
|
3353
|
+
**Published:** 2026-08-18
|
|
3354
|
+
* OpenAPI spec version: 2026.16.1
|
|
3349
3355
|
*/
|
|
3350
3356
|
/**
|
|
3351
3357
|
* Request body for creating a Program Summary Recording task (RWA-2427)
|
|
@@ -3371,8 +3377,8 @@ interface ProgramSummaryTaskRequest {
|
|
|
3371
3377
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3372
3378
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3373
3379
|
|
|
3374
|
-
**Published:** 2026-08-
|
|
3375
|
-
* OpenAPI spec version: 2026.16.
|
|
3380
|
+
**Published:** 2026-08-18
|
|
3381
|
+
* OpenAPI spec version: 2026.16.1
|
|
3376
3382
|
*/
|
|
3377
3383
|
/**
|
|
3378
3384
|
* Response body for a successfully created Program Summary Recording task
|
|
@@ -3398,36 +3404,8 @@ interface ProgramSummaryTaskResponse {
|
|
|
3398
3404
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3399
3405
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3400
3406
|
|
|
3401
|
-
**Published:** 2026-08-
|
|
3402
|
-
* OpenAPI spec version: 2026.16.
|
|
3403
|
-
*/
|
|
3404
|
-
|
|
3405
|
-
/**
|
|
3406
|
-
* Error body returned when a readiness gate blocks UW submission. Observed live as a 400 with error_code ER40301.
|
|
3407
|
-
|
|
3408
|
-
⚠️ Patched locally by `openapi/repairs.ts` — this differs from FDR's published spec.
|
|
3409
|
-
*/
|
|
3410
|
-
interface ReadinessErrorResponse {
|
|
3411
|
-
status?: number;
|
|
3412
|
-
/** Short error message */
|
|
3413
|
-
error?: string;
|
|
3414
|
-
/** Error classification code */
|
|
3415
|
-
error_code?: string;
|
|
3416
|
-
/** UTC timestamp of the error */
|
|
3417
|
-
timestamp?: string;
|
|
3418
|
-
/** Correlation ID for distributed tracing */
|
|
3419
|
-
x_correlation_id?: string;
|
|
3420
|
-
error_details?: ErrorDetails;
|
|
3421
|
-
}
|
|
3422
|
-
|
|
3423
|
-
/**
|
|
3424
|
-
* Generated by orval v7.21.0 🍺
|
|
3425
|
-
* Do not edit manually.
|
|
3426
|
-
* ARPC — Achieve Resolution Partner Connect API
|
|
3427
|
-
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3428
|
-
|
|
3429
|
-
**Published:** 2026-08-08
|
|
3430
|
-
* OpenAPI spec version: 2026.16.0
|
|
3407
|
+
**Published:** 2026-08-18
|
|
3408
|
+
* OpenAPI spec version: 2026.16.1
|
|
3431
3409
|
*/
|
|
3432
3410
|
|
|
3433
3411
|
/**
|
|
@@ -3454,8 +3432,8 @@ interface ReadinessResponse {
|
|
|
3454
3432
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3455
3433
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3456
3434
|
|
|
3457
|
-
**Published:** 2026-08-
|
|
3458
|
-
* OpenAPI spec version: 2026.16.
|
|
3435
|
+
**Published:** 2026-08-18
|
|
3436
|
+
* OpenAPI spec version: 2026.16.1
|
|
3459
3437
|
*/
|
|
3460
3438
|
|
|
3461
3439
|
/**
|
|
@@ -3473,8 +3451,8 @@ interface RegisterApplicantV2Request {
|
|
|
3473
3451
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3474
3452
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3475
3453
|
|
|
3476
|
-
**Published:** 2026-08-
|
|
3477
|
-
* OpenAPI spec version: 2026.16.
|
|
3454
|
+
**Published:** 2026-08-18
|
|
3455
|
+
* OpenAPI spec version: 2026.16.1
|
|
3478
3456
|
*/
|
|
3479
3457
|
/**
|
|
3480
3458
|
* Response returned after successfully registering an applicant via POST /v2/applicant/register
|
|
@@ -3496,8 +3474,8 @@ interface RegisterApplicantV2Response {
|
|
|
3496
3474
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3497
3475
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3498
3476
|
|
|
3499
|
-
**Published:** 2026-08-
|
|
3500
|
-
* OpenAPI spec version: 2026.16.
|
|
3477
|
+
**Published:** 2026-08-18
|
|
3478
|
+
* OpenAPI spec version: 2026.16.1
|
|
3501
3479
|
*/
|
|
3502
3480
|
|
|
3503
3481
|
/**
|
|
@@ -3523,8 +3501,8 @@ interface SpinwheelNetworkUserRequest {
|
|
|
3523
3501
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3524
3502
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3525
3503
|
|
|
3526
|
-
**Published:** 2026-08-
|
|
3527
|
-
* OpenAPI spec version: 2026.16.
|
|
3504
|
+
**Published:** 2026-08-18
|
|
3505
|
+
* OpenAPI spec version: 2026.16.1
|
|
3528
3506
|
*/
|
|
3529
3507
|
/**
|
|
3530
3508
|
* Result of creating or connecting a Spinwheel network user
|
|
@@ -3542,8 +3520,8 @@ interface SpinwheelNetworkUserResponse {
|
|
|
3542
3520
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3543
3521
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3544
3522
|
|
|
3545
|
-
**Published:** 2026-08-
|
|
3546
|
-
* OpenAPI spec version: 2026.16.
|
|
3523
|
+
**Published:** 2026-08-18
|
|
3524
|
+
* OpenAPI spec version: 2026.16.1
|
|
3547
3525
|
*/
|
|
3548
3526
|
/**
|
|
3549
3527
|
* Primary hardship category
|
|
@@ -3564,8 +3542,8 @@ declare const StatelessReadinessRequestHardshipCategory: {
|
|
|
3564
3542
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3565
3543
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3566
3544
|
|
|
3567
|
-
**Published:** 2026-08-
|
|
3568
|
-
* OpenAPI spec version: 2026.16.
|
|
3545
|
+
**Published:** 2026-08-18
|
|
3546
|
+
* OpenAPI spec version: 2026.16.1
|
|
3569
3547
|
*/
|
|
3570
3548
|
/**
|
|
3571
3549
|
* Primary goal category
|
|
@@ -3584,8 +3562,8 @@ declare const StatelessReadinessRequestGoalCategory: {
|
|
|
3584
3562
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3585
3563
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3586
3564
|
|
|
3587
|
-
**Published:** 2026-08-
|
|
3588
|
-
* OpenAPI spec version: 2026.16.
|
|
3565
|
+
**Published:** 2026-08-18
|
|
3566
|
+
* OpenAPI spec version: 2026.16.1
|
|
3589
3567
|
*/
|
|
3590
3568
|
|
|
3591
3569
|
/**
|
|
@@ -3723,19 +3701,91 @@ interface StatelessReadinessRequest {
|
|
|
3723
3701
|
* ARPC — Achieve Resolution Partner Connect API
|
|
3724
3702
|
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3725
3703
|
|
|
3726
|
-
**Published:** 2026-08-
|
|
3727
|
-
* OpenAPI spec version: 2026.16.
|
|
3704
|
+
**Published:** 2026-08-18
|
|
3705
|
+
* OpenAPI spec version: 2026.16.1
|
|
3706
|
+
*/
|
|
3707
|
+
/**
|
|
3708
|
+
* Thin applicant projection returned within UW Submission V2
|
|
3709
|
+
*/
|
|
3710
|
+
interface UwSubmissionV2Applicant {
|
|
3711
|
+
/** Applicant record identifier */
|
|
3712
|
+
id?: string;
|
|
3713
|
+
/** Applicant email */
|
|
3714
|
+
email?: string;
|
|
3715
|
+
/** Unique FDR applicant ID */
|
|
3716
|
+
fdr_applicant_id?: string;
|
|
3717
|
+
/** Applicant first name */
|
|
3718
|
+
first_name?: string;
|
|
3719
|
+
/** Applicant last name */
|
|
3720
|
+
last_name?: string;
|
|
3721
|
+
/** Applicant email */
|
|
3722
|
+
client_email?: string;
|
|
3723
|
+
/** Applicant identity identifier */
|
|
3724
|
+
cerebro_id?: string;
|
|
3725
|
+
}
|
|
3726
|
+
|
|
3727
|
+
/**
|
|
3728
|
+
* Generated by orval v7.21.0 🍺
|
|
3729
|
+
* Do not edit manually.
|
|
3730
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
3731
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3732
|
+
|
|
3733
|
+
**Published:** 2026-08-18
|
|
3734
|
+
* OpenAPI spec version: 2026.16.1
|
|
3735
|
+
*/
|
|
3736
|
+
|
|
3737
|
+
/**
|
|
3738
|
+
* Thin application projection returned by UW Submission V2
|
|
3739
|
+
*/
|
|
3740
|
+
interface UwSubmissionV2Application {
|
|
3741
|
+
/** Application language */
|
|
3742
|
+
language?: string;
|
|
3743
|
+
applicant?: UwSubmissionV2Applicant;
|
|
3744
|
+
/** Application conditions */
|
|
3745
|
+
conditions?: LeadCondition[];
|
|
3746
|
+
/** Unique FDR applicant ID */
|
|
3747
|
+
fdr_applicant_id?: string;
|
|
3748
|
+
/** Current underwriting sub-status */
|
|
3749
|
+
sub_status?: string;
|
|
3750
|
+
/** Underlying application object type */
|
|
3751
|
+
object_type?: string;
|
|
3752
|
+
/** Current opportunity state */
|
|
3753
|
+
opportunity_state?: string;
|
|
3754
|
+
/** Applicant email associated with the application */
|
|
3755
|
+
client_email?: string;
|
|
3756
|
+
/** Applicant last name */
|
|
3757
|
+
last_name?: string;
|
|
3758
|
+
/** Law firm identifier */
|
|
3759
|
+
law_firm_id?: string;
|
|
3760
|
+
/** Current application stage */
|
|
3761
|
+
stage_name?: string;
|
|
3762
|
+
/** Application creation timestamp */
|
|
3763
|
+
created_date?: string;
|
|
3764
|
+
/** Applicant first name */
|
|
3765
|
+
first_name?: string;
|
|
3766
|
+
/** Applicant email */
|
|
3767
|
+
email?: string;
|
|
3768
|
+
}
|
|
3769
|
+
|
|
3770
|
+
/**
|
|
3771
|
+
* Generated by orval v7.21.0 🍺
|
|
3772
|
+
* Do not edit manually.
|
|
3773
|
+
* ARPC — Achieve Resolution Partner Connect API
|
|
3774
|
+
* FDR Wholesale API — A Hybrid Integration Model designed to maximise partner velocity without compromising enterprise data standards. DEX (Digital Enrollment Experience) is the partner-facing integration layer that powers the full applicant lifecycle. The `fdr_applicant_id` acts as the applicant's passport across all systems, persisted from first eligibility check through enrollment. All endpoints require a valid Bearer JWT with the `arpc.all` role.
|
|
3775
|
+
|
|
3776
|
+
**Published:** 2026-08-18
|
|
3777
|
+
* OpenAPI spec version: 2026.16.1
|
|
3728
3778
|
*/
|
|
3729
3779
|
|
|
3730
3780
|
/**
|
|
3731
|
-
* UW Submission V2 response
|
|
3781
|
+
* UW Submission V2 response with a thin application projection, readiness checks, and two banking-disclosure outcome fields. Banking disclosure email is sent automatically on full UW approval (sub_status = 'UW Approved') and suppressed for conditional approvals.
|
|
3732
3782
|
*/
|
|
3733
3783
|
interface UwSubmissionV2Response {
|
|
3734
|
-
/**
|
|
3784
|
+
/** Response identifier */
|
|
3735
3785
|
id?: string;
|
|
3736
3786
|
/** Result message */
|
|
3737
3787
|
message?: string;
|
|
3738
|
-
application?:
|
|
3788
|
+
application?: UwSubmissionV2Application;
|
|
3739
3789
|
readiness?: LeadReadiness;
|
|
3740
3790
|
/** True when the banking disclosure email was sent successfully. False when the email was intentionally suppressed (e.g. conditional approval) or the downstream email service failed (failure is non-blocking). */
|
|
3741
3791
|
banking_disclosure_email_sent?: boolean;
|
|
@@ -3754,9 +3804,10 @@ interface UwSubmissionV2Response {
|
|
|
3754
3804
|
* against what came back always looks like a failure.
|
|
3755
3805
|
*
|
|
3756
3806
|
* The labels below were confirmed against live STG by selecting each draft type
|
|
3757
|
-
* in turn
|
|
3758
|
-
* `Twice Monthly [Split]
|
|
3759
|
-
*
|
|
3807
|
+
* in turn. Through 2026.16.0 the spec documented `Monthly [Regular]` and
|
|
3808
|
+
* `Twice Monthly [Split]` for two of them and the API returned neither; 16.1
|
|
3809
|
+
* corrected the response enum, so the generated types now agree with the wire.
|
|
3810
|
+
* The two *vocabularies* remain — a corrected enum is not a unified one.
|
|
3760
3811
|
*
|
|
3761
3812
|
* Scope is narrow: `LeadApplication.draft_type` is the only label-valued site
|
|
3762
3813
|
* in the whole spec. `PaymentSchedule` and `ProgramSelectionRequest` are both
|
|
@@ -3846,4 +3897,4 @@ declare class ArpcSDK {
|
|
|
3846
3897
|
constructor(config: ArpcConfig);
|
|
3847
3898
|
}
|
|
3848
3899
|
|
|
3849
|
-
export { type ARPCErrorResponse, ARPC_ENDPOINTS, type Address, type Applicant, type ApplicationSendEmailResponse, type ArpcAuth, type ArpcConfig, type ArpcEndpoint, type ArpcEnvironment, ArpcSDK, type ArpcUrls, type AuditInfo, type BankDetails, BankDetailsAccountSubtype, BankDetailsAccountType, type BankDetailsInput, type BankUpdateRequest, type Check, CheckType, type CoApplicant, type Consents, type CreateLeadRequest, CreateLeadRequestGoalCategory, CreateLeadRequestHardshipCategory, type CreateLeadResponse, type CreditPullConsent, DRAFT_TYPE_CODE, DRAFT_TYPE_LABEL, type DebtAccount, type DraApplicant, type DraApplicantInput, DraApplicantInputSigningType, type DraRequest, type DraResponse, type EligibilityAddress, type EligibilityApplicant, type EligibilityApplication, type EligibilityDebtAccount, type EligibilityRequest, type EligibilityResponse, type ErrorDetails, type FieldValidationError, FieldValidationErrorReasonCode, type HttpResponse, type IneligibleReason, IneligibleReasonReasonId, type LeadApplicant, LeadApplicantBankruptcy, LeadApplicantEmploymentStatus, type LeadApplicantInput, LeadApplicantPayFrequency, type LeadApplication, LeadApplicationCreditPullSource, LeadApplicationDraftType, LeadApplicationFdrOrCss, LeadApplicationFixedIncome, LeadApplicationGoalCategory, LeadApplicationHardshipCategory, LeadApplicationLanguage, LeadApplicationOwnOrRent, LeadApplicationSecondaryGoal, LeadApplicationStatus, LeadApplicationSubStatus, type LeadCondition, LeadConditionActive, LeadConditionType, type LeadCreditor, type LeadDebtAccount, LeadDebtAccountAccountType, LeadDebtAccountOwnership, LeadDebtAccountResponsibility, LeadDebtAccountSource, type LeadDistribution, type LeadPatchRequest, LeadPatchRequestGoalCategory, LeadPatchRequestHardshipCategory, type LeadReadiness, type LeadResponse, type LeadTransferRequest, type LeadTransferResponse, LeadTransferResponseResponse, type MailingAddress, type PatchAddress, type PatchApplicant, type PatchCoApplicant, type PatchCondition, type PatchDebtAccount, type PaymentOption, PaymentOptionEvaluationType, type PaymentSchedule, PaymentScheduleDraftType, type PaymentScheduleOption, PaymentScheduleOptionEvaluationType, type ProgramRequest, type ProgramSelectionApplicant, type ProgramSelectionRequest, ProgramSelectionRequestDraftType, type ProgramSummaryTaskRequest, type ProgramSummaryTaskResponse, type ReadinessCheck, ReadinessCheckType, type ReadinessErrorDetail, ReadinessErrorDetailReasonCode, type
|
|
3900
|
+
export { type ARPCErrorResponse, ARPC_ENDPOINTS, type Address, type Applicant, type ApplicationSendEmailResponse, type ArpcAuth, type ArpcConfig, type ArpcEndpoint, type ArpcEnvironment, ArpcSDK, type ArpcUrls, type AuditInfo, type BankDetails, BankDetailsAccountSubtype, BankDetailsAccountType, type BankDetailsInput, type BankUpdateRequest, type Check, CheckType, type CoApplicant, type Consents, type CreateLeadRequest, CreateLeadRequestGoalCategory, CreateLeadRequestHardshipCategory, type CreateLeadResponse, type CreditPullConsent, DRAFT_TYPE_CODE, DRAFT_TYPE_LABEL, type DebtAccount, type DraApplicant, type DraApplicantInput, DraApplicantInputSigningType, type DraRequest, type DraResponse, type EligibilityAddress, type EligibilityApplicant, type EligibilityApplication, type EligibilityDebtAccount, type EligibilityRequest, type EligibilityResponse, type ErrorDetails, type FieldValidationError, FieldValidationErrorReasonCode, type HttpResponse, type IneligibleReason, IneligibleReasonReasonId, type LeadApplicant, LeadApplicantBankruptcy, LeadApplicantEmploymentStatus, type LeadApplicantInput, LeadApplicantPayFrequency, type LeadApplication, LeadApplicationCreditPullSource, LeadApplicationDraftType, LeadApplicationFdrOrCss, LeadApplicationFixedIncome, LeadApplicationGoalCategory, LeadApplicationHardshipCategory, LeadApplicationLanguage, LeadApplicationOwnOrRent, LeadApplicationSecondaryGoal, LeadApplicationStatus, LeadApplicationSubStatus, type LeadCondition, LeadConditionActive, LeadConditionType, type LeadCreditor, type LeadDebtAccount, LeadDebtAccountAccountType, LeadDebtAccountOwnership, LeadDebtAccountResponsibility, LeadDebtAccountSource, type LeadDistribution, type LeadPatchRequest, LeadPatchRequestGoalCategory, LeadPatchRequestHardshipCategory, type LeadReadiness, type LeadResponse, type LeadTransferRequest, type LeadTransferResponse, LeadTransferResponseResponse, type MailingAddress, type PatchAddress, type PatchApplicant, type PatchCoApplicant, type PatchCondition, type PatchDebtAccount, type PaymentOption, PaymentOptionEvaluationType, type PaymentSchedule, PaymentScheduleDraftType, type PaymentScheduleOption, PaymentScheduleOptionEvaluationType, type ProgramRequest, type ProgramSelectionApplicant, type ProgramSelectionRequest, ProgramSelectionRequestDraftType, type ProgramSummaryTaskRequest, type ProgramSummaryTaskResponse, type ReadinessCheck, ReadinessCheckType, type ReadinessErrorDetail, ReadinessErrorDetailReasonCode, type ReadinessResponse, type RegisterApplicantV2Address, type RegisterApplicantV2Request, type RegisterApplicantV2Response, type SpinwheelNetworkUserRequest, type SpinwheelNetworkUserResponse, type StatelessReadinessRequest, StatelessReadinessRequestGoalCategory, StatelessReadinessRequestHardshipCategory, type TokenCache, type Tracking, type UwSubmissionV2Applicant, type UwSubmissionV2Application, type UwSubmissionV2Response, draftTypeOf, isArpcEnvironment };
|