Interface: PathsDictionary

src/DocFoxClient.PathsDictionary

Properties

/api/v2/account_addons/{account_addon_id}

• /api/v2/account_addons/{account_addon_id}: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:9521

---

/api/v2/account_applications/{account_application_id}

• /api/v2/account_applications/{account_application_id}: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>
patch	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404 | $406>

Defined in

src/ClientTypes.ts:9711

---

/api/v2/account_applications/{account_application_id}/account_addons

• /api/v2/account_applications/{account_application_id}/account_addons: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:9506

---

/api/v2/account_applications/{account_application_id}/data_requirements

• /api/v2/account_applications/{account_application_id}/data_requirements: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:9638

---

/api/v2/account_applications/{id}/account_summary

• /api/v2/account_applications/{id}/account_summary: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $404>

Defined in

src/ClientTypes.ts:9668

---

/api/v2/account_applications/{id}/account_summary_pdf

• /api/v2/account_applications/{id}/account_summary_pdf: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $404>

Defined in

src/ClientTypes.ts:9609

---

/api/v2/account_applications/{id}/disclosure_acceptances

• /api/v2/account_applications/{id}/disclosure_acceptances: Object

Type declaration

Name	Type
patch	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404 | $406>

Defined in

src/ClientTypes.ts:9738

---

/api/v2/additional_details/{additional_detail_id}

• /api/v2/additional_details/{additional_detail_id}: Object

Type declaration

Name	Type
delete	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$204 | $400 | $401 | $404 | $422>
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>
patch	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404 | $406 | $422>

Defined in

src/ClientTypes.ts:8317

---

/api/v2/addresses/{address_id}

• /api/v2/addresses/{address_id}: Object

Type declaration

Name	Type
delete	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$204 | $400 | $401 | $404>
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>
patch	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404 | $406 | $422>

Defined in

src/ClientTypes.ts:8250

---

/api/v2/authentications/new

• /api/v2/authentications/new: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401>

Defined in

src/ClientTypes.ts:7861

---

/api/v2/bank_account_schemas/{kyc_application_id}

• /api/v2/bank_account_schemas/{kyc_application_id}: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:9185

---

/api/v2/bank_account_verifications/{bank_account_verification_id}

• /api/v2/bank_account_verifications/{bank_account_verification_id}: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>
patch	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404 | $406>

Defined in

src/ClientTypes.ts:9240

---

/api/v2/bank_accounts/{bank_account_id}

• /api/v2/bank_accounts/{bank_account_id}: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:9228

---

/api/v2/bank_accounts/{bank_account_id}/bank_account_verifications

• /api/v2/bank_accounts/{bank_account_id}/bank_account_verifications: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:9270

---

/api/v2/comparison_results/{comparison_result_id}

• /api/v2/comparison_results/{comparison_result_id}: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:8646

---

/api/v2/consumer_report_queries/{id}

• /api/v2/consumer_report_queries/{id}: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:9300

---

/api/v2/consumer_report_queries/{id}/download

• /api/v2/consumer_report_queries/{id}/download: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$302 | $400 | $401 | $404 | $406 | $409>

Defined in

src/ClientTypes.ts:9312

---

/api/v2/contacts/{contact_id}

• /api/v2/contacts/{contact_id}: Object

Type declaration

Name	Type
delete	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$204 | $400 | $401 | $404>
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>
patch	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404 | $406 | $422>

Defined in

src/ClientTypes.ts:8189

---

/api/v2/contacts/{contact_id}/data_requirement_permissions

• /api/v2/contacts/{contact_id}/data_requirement_permissions: Object

Type declaration

Name	Type
post	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$201 | $400 | $401 | $404 | $406 | $409 | $422>

Defined in

src/ClientTypes.ts:8505

---

/api/v2/contacts/{contact_information_id}/data_requirement_permissions

• /api/v2/contacts/{contact_information_id}/data_requirement_permissions: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:8411

---

/api/v2/contacts/{contact_information_id}/invitation_tokens

• /api/v2/contacts/{contact_information_id}/invitation_tokens: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>
post	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$201 | $400 | $401 | $404 | $406 | $409 | $422>

Defined in

src/ClientTypes.ts:8354

---

/api/v2/data_comparisons/{data_comparison_id}

• /api/v2/data_comparisons/{data_comparison_id}: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:8589

---

/api/v2/data_comparisons/{data_comparison_id}/comparison_results

• /api/v2/data_comparisons/{data_comparison_id}/comparison_results: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:8631

---

/api/v2/data_requirement_permissions

• /api/v2/data_requirement_permissions: Object

Type declaration

Name	Type
post	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$201 | $400 | $401 | $404 | $406 | $409 | $422>

Defined in

src/ClientTypes.ts:8455

---

/api/v2/data_requirement_permissions/{data_requirement_permission_id}

• /api/v2/data_requirement_permissions/{data_requirement_permission_id}: Object

Type declaration

Name	Type
delete	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$204 | $400 | $401 | $404>
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:8426

---

/api/v2/data_requirements/{data_requirement_id}

• /api/v2/data_requirements/{data_requirement_id}: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:8538

---

/api/v2/data_requirements/{data_requirement_id}/data_comparisons

• /api/v2/data_requirements/{data_requirement_id}/data_comparisons: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:8616

---

/api/v2/data_requirements/{data_requirement_id}/data_requirement_permissions

• /api/v2/data_requirements/{data_requirement_id}/data_requirement_permissions: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>
post	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$201 | $400 | $401 | $404 | $406 | $409 | $422>

Defined in

src/ClientTypes.ts:8473

---

/api/v2/data_requirements/{data_requirement_id}/evidence_submissions

• /api/v2/data_requirements/{data_requirement_id}/evidence_submissions: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:8658

---

/api/v2/disclosures

• /api/v2/disclosures: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $403>

Defined in

src/ClientTypes.ts:9546

---

/api/v2/disclosures/{disclosure_id}

• /api/v2/disclosures/{disclosure_id}: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:9558

---

/api/v2/document_file_downloads/{document_token_id}

• /api/v2/document_file_downloads/{document_token_id}: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$302 | $404 | $406 | $410>

Defined in

src/ClientTypes.ts:8886

---

/api/v2/document_tokens/{document_token_id}

• /api/v2/document_tokens/{document_token_id}: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:8874

---

/api/v2/documents/{document_id}

• /api/v2/documents/{document_id}: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:8832

---

/api/v2/documents/{document_id}/document_tokens

• /api/v2/documents/{document_id}/document_tokens: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>
post	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$201 | $400 | $401 | $404 | $406>

Defined in

src/ClientTypes.ts:8844

---

/api/v2/evidence_submissions/{evidence_submission_id}

• /api/v2/evidence_submissions/{evidence_submission_id}: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>
patch	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404 | $406 | $409>

Defined in

src/ClientTypes.ts:8673

---

/api/v2/evidence_submissions/{evidence_submission_id}/approve

• /api/v2/evidence_submissions/{evidence_submission_id}/approve: Object

Type declaration

Name	Type
patch	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404 | $406>

Defined in

src/ClientTypes.ts:8717

---

/api/v2/evidence_submissions/{evidence_submission_id}/documents

• /api/v2/evidence_submissions/{evidence_submission_id}/documents: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>
post	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$201 | $400 | $404 | $422>

Defined in

src/ClientTypes.ts:8803

---

/api/v2/evidence_submissions/{evidence_submission_id}/qualitative_checks

• /api/v2/evidence_submissions/{evidence_submission_id}/qualitative_checks: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:8749

---

/api/v2/evidence_submissions/{evidence_submission_id}/reject

• /api/v2/evidence_submissions/{evidence_submission_id}/reject: Object

Type declaration

Name	Type
patch	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404 | $406>

Defined in

src/ClientTypes.ts:8701

---

/api/v2/evidence_submissions/{evidence_submission_id}/rejection_reasons

• /api/v2/evidence_submissions/{evidence_submission_id}/rejection_reasons: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:8776

---

/api/v2/evidence_submissions/{evidence_submission_id}/replace

• /api/v2/evidence_submissions/{evidence_submission_id}/replace: Object

Type declaration

Name	Type
patch	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404 | $406>

Defined in

src/ClientTypes.ts:8733

---

/api/v2/form_data/{form_datum_id}

• /api/v2/form_data/{form_datum_id}: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:8932

---

/api/v2/form_pdf_exports/{form_pdf_export_id}/

• /api/v2/form_pdf_exports/{form_pdf_export_id}/: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:9387

---

/api/v2/form_pdf_exports/{form_pdf_export_id}/download

• /api/v2/form_pdf_exports/{form_pdf_export_id}/download: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$302 | $400 | $401 | $404 | $406 | $409>

Defined in

src/ClientTypes.ts:9399

---

/api/v2/forms/{form_id}

• /api/v2/forms/{form_id}: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:8898

---

/api/v2/forms/{form_id}/form_data

• /api/v2/forms/{form_id}/form_data: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>
post	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$201 | $404 | $422>

Defined in

src/ClientTypes.ts:8910

---

/api/v2/forms/{form_id}/form_pdf_exports

• /api/v2/forms/{form_id}/form_pdf_exports: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>
post	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$201 | $400 | $401 | $404 | $406 | $429>

Defined in

src/ClientTypes.ts:9362

---

/api/v2/invitation_tokens/{invitation_token_id}

• /api/v2/invitation_tokens/{invitation_token_id}: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>
patch	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404 | $406 | $409>

Defined in

src/ClientTypes.ts:8386

---

/api/v2/kyc_applications

• /api/v2/kyc_applications: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $403>
post	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$201 | $400 | $401 | $406 | $422>

Defined in

src/ClientTypes.ts:7883

---

/api/v2/kyc_applications/{kyc_application_id}

• /api/v2/kyc_applications/{kyc_application_id}: Object

Type declaration

Name	Type
delete	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$204 | $400 | $401 | $404>
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:7907

---

/api/v2/kyc_applications/{kyc_application_id}/account_applications

• /api/v2/kyc_applications/{kyc_application_id}/account_applications: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>
post	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$201 | $400 | $401 | $404 | $406>

Defined in

src/ClientTypes.ts:9681

---

/api/v2/kyc_applications/{kyc_application_id}/approve

• /api/v2/kyc_applications/{kyc_application_id}/approve: Object

Type declaration

Name	Type
patch	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404 | $406 | $422>

Defined in

src/ClientTypes.ts:7930

---

/api/v2/kyc_applications/{kyc_application_id}/archive

• /api/v2/kyc_applications/{kyc_application_id}/archive: Object

Type declaration

Name	Type
post	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$204 | $400>

Defined in

src/ClientTypes.ts:7981

---

/api/v2/kyc_applications/{kyc_application_id}/bank_accounts

• /api/v2/kyc_applications/{kyc_application_id}/bank_accounts: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>
post	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$201 | $400 | $401 | $404 | $406 | $422>

Defined in

src/ClientTypes.ts:9197

---

/api/v2/kyc_applications/{kyc_application_id}/consumer_report_queries

• /api/v2/kyc_applications/{kyc_application_id}/consumer_report_queries: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:9285

---

/api/v2/kyc_applications/{kyc_application_id}/data_comparisons

• /api/v2/kyc_applications/{kyc_application_id}/data_comparisons: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:8574

---

/api/v2/kyc_applications/{kyc_application_id}/data_requirements

• /api/v2/kyc_applications/{kyc_application_id}/data_requirements: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:8523

---

/api/v2/kyc_applications/{kyc_application_id}/pdf_report_summaries

• /api/v2/kyc_applications/{kyc_application_id}/pdf_report_summaries: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>
post	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$201 | $400 | $401 | $404 | $406 | $429>

Defined in

src/ClientTypes.ts:9001

---

/api/v2/kyc_applications/{kyc_application_id}/profiles

• /api/v2/kyc_applications/{kyc_application_id}/profiles: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:8014

---

/api/v2/kyc_applications/{kyc_application_id}/related_entities

• /api/v2/kyc_applications/{kyc_application_id}/related_entities: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404 | $409>
post	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$201 | $400 | $401 | $404 | $406 | $409 | $422>

Defined in

src/ClientTypes.ts:8944

---

/api/v2/kyc_applications/{kyc_application_id}/risk_rating_evaluations

• /api/v2/kyc_applications/{kyc_application_id}/risk_rating_evaluations: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:9097

---

/api/v2/kyc_applications/{kyc_application_id}/risk_ratings

• /api/v2/kyc_applications/{kyc_application_id}/risk_ratings: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>
post	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$201 | $400 | $401 | $404 | $406>

Defined in

src/ClientTypes.ts:9112

---

/api/v2/kyc_applications/{kyc_application_id}/risk_ratings/questions

• /api/v2/kyc_applications/{kyc_application_id}/risk_ratings/questions: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $404>
patch	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404 | $406>

Defined in

src/ClientTypes.ts:9157

---

/api/v2/kyc_applications/{kyc_application_id}/risk_ratings/{evaluation_id}

• /api/v2/kyc_applications/{kyc_application_id}/risk_ratings/{evaluation_id}: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:9142

---

/api/v2/kyc_applications/{kyc_application_id}/status_summaries

• /api/v2/kyc_applications/{kyc_application_id}/status_summaries: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:7999

---

/api/v2/kyc_applications/{kyc_application_id}/transfer

• /api/v2/kyc_applications/{kyc_application_id}/transfer: Object

Type declaration

Name	Type
patch	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404 | $406 | $422>

Defined in

src/ClientTypes.ts:7964

---

/api/v2/kyc_applications/{kyc_application_id}/unapprove

• /api/v2/kyc_applications/{kyc_application_id}/unapprove: Object

Type declaration

Name	Type
patch	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404 | $406 | $422>

Defined in

src/ClientTypes.ts:7947

---

/api/v2/kyc_applications/{kyc_application_id}/unarchive

• /api/v2/kyc_applications/{kyc_application_id}/unarchive: Object

Type declaration

Name	Type
post	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400>

Defined in

src/ClientTypes.ts:7990

---

/api/v2/kyc_entity_templates

• /api/v2/kyc_entity_templates: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $403>

Defined in

src/ClientTypes.ts:8550

---

/api/v2/kyc_entity_templates/{kyc_entity_template_id}

• /api/v2/kyc_entity_templates/{kyc_entity_template_id}: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:8562

---

/api/v2/kyc_entity_templates/{kyc_entity_template_id}/designation_templates

• /api/v2/kyc_entity_templates/{kyc_entity_template_id}/designation_templates: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:9416

---

/api/v2/kyc_entity_templates/{kyc_entity_template_id}/disclosures

• /api/v2/kyc_entity_templates/{kyc_entity_template_id}/disclosures: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $403 | $404>

Defined in

src/ClientTypes.ts:9622

---

/api/v2/kyc_entity_templates/{kyc_entity_template_id}/products

• /api/v2/kyc_entity_templates/{kyc_entity_template_id}/products: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:9594

---

/api/v2/names/{name_id}

• /api/v2/names/{name_id}: Object

Type declaration

Name	Type
delete	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$204 | $400 | $401 | $404>
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>
patch	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404 | $406 | $422>

Defined in

src/ClientTypes.ts:8066

---

/api/v2/numbers/{number_id}

• /api/v2/numbers/{number_id}: Object

Type declaration

Name	Type
delete	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$204 | $400 | $401 | $404 | $422>
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>
patch	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404 | $406 | $422>

Defined in

src/ClientTypes.ts:8127

---

/api/v2/onboarding_invitations

• /api/v2/onboarding_invitations: Object

Type declaration

Name	Type
post	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$201 | $400 | $401 | $403 | $406>

Defined in

src/ClientTypes.ts:9329

---

/api/v2/onboarding_invitations/{kyc_application_id}

• /api/v2/onboarding_invitations/{kyc_application_id}: Object

Type declaration

Name	Type
patch	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404 | $406 | $422>

Defined in

src/ClientTypes.ts:9345

---

/api/v2/pdf_report_summaries/{pdf_report_summary_id}/

• /api/v2/pdf_report_summaries/{pdf_report_summary_id}/: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:9032

---

/api/v2/pdf_report_summaries/{pdf_summary_report_id}/download

• /api/v2/pdf_report_summaries/{pdf_summary_report_id}/download: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$302 | $400 | $401 | $404 | $406 | $409>

Defined in

src/ClientTypes.ts:9044

---

/api/v2/product_product_addons/disclosures

• /api/v2/product_product_addons/disclosures: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $403>

Defined in

src/ClientTypes.ts:9653

---

/api/v2/products

• /api/v2/products: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $403>

Defined in

src/ClientTypes.ts:9570

---

/api/v2/products/{id}

• /api/v2/products/{id}: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:9582

---

/api/v2/products/{product_id}/disclosures

• /api/v2/products/{product_id}/disclosures: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $403 | $404>

Defined in

src/ClientTypes.ts:9533

---

/api/v2/products/{product_id}/product_product_addons

• /api/v2/products/{product_id}/product_product_addons: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:9491

---

/api/v2/profiles/{profile_id}

• /api/v2/profiles/{profile_id}: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:8029

---

/api/v2/profiles/{profile_id}/additional_details

• /api/v2/profiles/{profile_id}/additional_details: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>
post	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$201 | $400 | $401 | $404 | $406 | $422>

Defined in

src/ClientTypes.ts:8286

---

/api/v2/profiles/{profile_id}/addresses

• /api/v2/profiles/{profile_id}/addresses: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>
post	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$201 | $400 | $401 | $404 | $406 | $422>

Defined in

src/ClientTypes.ts:8225

---

/api/v2/profiles/{profile_id}/contacts

• /api/v2/profiles/{profile_id}/contacts: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>
post	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$201 | $400 | $401 | $404 | $406 | $422>

Defined in

src/ClientTypes.ts:8164

---

/api/v2/profiles/{profile_id}/data_comparisons

• /api/v2/profiles/{profile_id}/data_comparisons: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:8601

---

/api/v2/profiles/{profile_id}/names

• /api/v2/profiles/{profile_id}/names: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>
post	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$201 | $400 | $401 | $404 | $406 | $422>

Defined in

src/ClientTypes.ts:8041

---

/api/v2/profiles/{profile_id}/numbers

• /api/v2/profiles/{profile_id}/numbers: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>
post	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$201 | $400 | $401 | $404 | $406 | $422>

Defined in

src/ClientTypes.ts:8102

---

/api/v2/qualitative_checks/{qualitative_check_id}

• /api/v2/qualitative_checks/{qualitative_check_id}: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:8764

---

/api/v2/rejection_reasons/{rejection_reason_id}

• /api/v2/rejection_reasons/{rejection_reason_id}: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:8791

---

/api/v2/related_entities/{related_entity_id}

• /api/v2/related_entities/{related_entity_id}: Object

Type declaration

Name	Type
delete	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$204 | $400 | $401 | $404 | $422>
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:8977

---

/api/v2/related_entities/{related_entity_id}/related_entity_designations

• /api/v2/related_entities/{related_entity_id}/related_entity_designations: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>
post	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$201 | $400 | $401 | $404 | $406 | $422>

Defined in

src/ClientTypes.ts:9460

---

/api/v2/related_entity_designations/{related_entity_designation_id}

• /api/v2/related_entity_designations/{related_entity_designation_id}: Object

Type declaration

Name	Type
delete	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$204 | $400 | $401 | $404>
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:9431

---

/api/v2/risk_rating_evaluations/{risk_rating_evaluation_id}

• /api/v2/risk_rating_evaluations/{risk_rating_evaluation_id}: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:9085

---

/api/v2/tokens/new

• /api/v2/tokens/new: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401>

Defined in

src/ClientTypes.ts:7872

---

/api/v2/users

• /api/v2/users: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $403>

Defined in

src/ClientTypes.ts:9061

---

/api/v2/users/{user_id}

• /api/v2/users/{user_id}: Object

Type declaration

Name	Type
get	(parameters?: null | Parameters<OperationParameters>, payload?: any, config?: AxiosRequestConfig<any>) => OperationResponse<$200 | $400 | $401 | $404>

Defined in

src/ClientTypes.ts:9073