Class: DocFoxClient

src/DocFoxClient.DocFoxClient

Constructors

constructor

• new DocFoxClient(key, secret, generator?, compatibilityMode?)

Parameters

Name	Type	Default value
key	string	undefined
secret	string	undefined
generator?	AuthTokenGeneratorFunction	undefined
compatibilityMode	boolean	false

Defined in

src/DocFoxClient.ts:88

Accessors

baseUrl

• get baseUrl(): string

Returns

string

Defined in

src/DocFoxClient.ts:164

---

client

• get client(): Client

Returns

Client

Defined in

src/DocFoxClient.ts:168

---

definitions

• get definitions(): Document

Returns

Document

Defined in

src/DocFoxClient.ts:172

---

interceptors

• get interceptors(): DoxFoxClientInterceptors

Returns

DoxFoxClientInterceptors

Defined in

src/DocFoxClient.ts:176

Methods

archiveKycApplication

▸ archiveKycApplication(params, payload?, config?): OperationResponse<$204 | $400>

Operation Method for POST /api/v2/kyc_applications/{kyc_application_id}/archive

Parameters

Name	Type
params	Object
params.kyc_application_id	string
payload?	Object
payload.data	Record<string, any>
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$204 | $400>

Tag

KYC Applications

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:934

---

clearAuth

▸ clearAuth(): void

Returns

void

Defined in

src/DocFoxClient.ts:208

---

createContactDataRequirementPermission

▸ createContactDataRequirementPermission(params, payload?, config?): OperationResponse<$201 | $400 | $401 | $404 | $406 | $409 | $422>

Operation Method for POST /api/v2/contacts/{contact_id}/data_requirement_permissions

Parameters

Name	Type
params	Object
params.contact_id	string
payload?	Object
payload.data	any
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$201 | $400 | $401 | $404 | $406 | $409 | $422>

Tag

Data Requirement Permissions

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1536

---

createContactInvitationToken

▸ createContactInvitationToken(params, payload?, config?): OperationResponse<$201 | $400 | $401 | $404 | $406 | $409 | $422>

Operation Method for POST /api/v2/contacts/{contact_information_id}/invitation_tokens

Parameters

Name	Type
params	Object
params.contact_information_id	string
payload?	Object
payload.data	any
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$201 | $400 | $401 | $404 | $406 | $409 | $422>

Tag

Invitation Tokens

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1385

---

createDataRequirementDataRequirementPermission

▸ createDataRequirementDataRequirementPermission(params, payload?, config?): OperationResponse<$201 | $400 | $401 | $404 | $406 | $409 | $422>

Operation Method for POST /api/v2/data_requirements/{data_requirement_id}/data_requirement_permissions

Parameters

Name	Type
params	Object
params.data_requirement_id	string
payload?	Object
payload.data	any
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$201 | $400 | $401 | $404 | $406 | $409 | $422>

Tag

Data Requirement Permissions

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1514

---

createDataRequirementPermission

▸ createDataRequirementPermission(params, payload?, config?): OperationResponse<$201 | $400 | $401 | $404 | $406 | $409 | $422>

Operation Method for POST /api/v2/data_requirement_permissions

Parameters

Name	Type
params	Object
payload?	Object
payload.data	any
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$201 | $400 | $401 | $404 | $406 | $409 | $422>

Tag

Data Requirement Permissions

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1478

---

createDocumentDocumentToken

▸ createDocumentDocumentToken(params, payload?, config?): OperationResponse<$201 | $400 | $401 | $404 | $406>

Operation Method for POST /api/v2/documents/{document_id}/document_tokens

Parameters

Name	Type
params	Object
params.document_id	string
payload?	Object
payload.data	any
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$201 | $400 | $401 | $404 | $406>

Tag

Document Tokens

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1920

---

createEvidenceSubmissionDocument

▸ createEvidenceSubmissionDocument(params, payload?, config?): OperationResponse<$201 | $400 | $404 | $422>

Operation Method for POST /api/v2/evidence_submissions/{evidence_submission_id}/documents

Parameters

Name	Type
params	Object
params.evidence_submission_id	string
payload?	Object
payload.data	any
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$201 | $400 | $404 | $422>

Tag

Document Uploads

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1877

---

createForm

▸ createForm(params, payload?, config?): OperationResponse<$201 | $404 | $422>

Operation Method for POST /api/v2/forms/{form_id}/form_data

Parameters

Name	Type
params	Object
params.form_id	string
payload?	Object
payload.data	any
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$201 | $404 | $422>

Tag

Form Data

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1991

---

createFormFormPdfExport

▸ createFormFormPdfExport(params, payload?, config?): OperationResponse<$201 | $400 | $401 | $404 | $406 | $429>

Operation Method for POST /api/v2/forms/{form_id}/form_pdf_exports

Parameters

Name	Type
params	Object
params.form_id	string
payload?	Object
payload.data	any
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$201 | $400 | $401 | $404 | $406 | $429>

Tag

Form PDF Exports

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2480

---

createKycApplication

▸ createKycApplication(params, payload?, config?): OperationResponse<$201 | $400 | $401 | $406 | $422>

Operation Method for POST /api/v2/kyc_applications

Parameters

Name	Type
params	Object
payload?	Object
payload.data	Record<string, any>
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$201 | $400 | $401 | $406 | $422>

Tag

KYC Applications

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:846

---

createKycApplicationAccountApplication

▸ createKycApplicationAccountApplication(params, payload?, config?): OperationResponse<$201 | $400 | $401 | $404 | $406>

Operation Method for POST /api/v2/kyc_applications/{kyc_application_id}/account_applications

Parameters

Name	Type
params	Object
params.kyc_application_id	string
payload?	Object
payload.data	any
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$201 | $400 | $401 | $404 | $406>

Tag

Account Applications

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2848

---

createKycApplicationBankAccount

▸ createKycApplicationBankAccount(params, payload?, config?): OperationResponse<$201 | $400 | $401 | $404 | $406 | $422>

Operation Method for POST /api/v2/kyc_applications/{kyc_application_id}/bank_accounts

Parameters

Name	Type
params	Object
params.kyc_application_id	string
payload?	Object
payload.data	any
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$201 | $400 | $401 | $404 | $406 | $422>

Tag

Bank Account Verification

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2308

---

createKycApplicationPdfReportSummarie

▸ createKycApplicationPdfReportSummarie(params, payload?, config?): OperationResponse<$201 | $400 | $401 | $404 | $406 | $429>

Operation Method for POST /api/v2/kyc_applications/{kyc_application_id}/pdf_report_summaries

Parameters

Name	Type
params	Object
params.kyc_application_id	string
payload?	Object
payload.data	any
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$201 | $400 | $401 | $404 | $406 | $429>

Tag

PDF Report Summaries

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2093

---

createKycApplicationRelatedEntitie

▸ createKycApplicationRelatedEntitie(params, payload?, config?): OperationResponse<$201 | $400 | $401 | $404 | $406 | $409 | $422>

Operation Method for POST /api/v2/kyc_applications/{kyc_application_id}/related_entities

Parameters

Name	Type
params	Object
params.kyc_application_id	string
payload?	Object
payload.data	Record<string, any>
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$201 | $400 | $401 | $404 | $406 | $409 | $422>

Tag

Related Entities

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2034

---

createKycApplicationRiskRating

▸ createKycApplicationRiskRating(params, payload?, config?): OperationResponse<$201 | $400 | $401 | $404 | $406>

Operation Method for POST /api/v2/kyc_applications/{kyc_application_id}/risk_ratings

Parameters

Name	Type
params	Object
params.kyc_application_id	string
payload?	Object
payload.data	any
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$201 | $400 | $401 | $404 | $406>

Tag

Risk Ratings

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2215

---

createOnboardingInvitation

▸ createOnboardingInvitation(params, payload?, config?): OperationResponse<$201 | $400 | $401 | $403 | $406>

Operation Method for POST /api/v2/onboarding_invitations

Parameters

Name	Type
params	Object
payload?	Object
payload.data	any
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$201 | $400 | $401 | $403 | $406>

Tag

Onboarding Invitation

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2436

---

createProfileAdditionalDetail

▸ createProfileAdditionalDetail(params, payload?, config?): OperationResponse<$201 | $400 | $401 | $404 | $406 | $422>

Operation Method for POST /api/v2/profiles/{profile_id}/additional_details

Parameters

Name	Type
params	Object
params.additional_detail_id	string
params.profile_id	string
payload?	Object
payload.data	any
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$201 | $400 | $401 | $404 | $406 | $422>

Tag

KYC Profile Additional Details

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1312

---

createProfileAddresse

▸ createProfileAddresse(params, payload?, config?): OperationResponse<$201 | $400 | $401 | $404 | $406 | $422>

Operation Method for POST /api/v2/profiles/{profile_id}/addresses

Parameters

Name	Type
params	Object
params.address_id	string
params.profile_id	string
payload?	Object
payload.data	any
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$201 | $400 | $401 | $404 | $406 | $422>

Tag

KYC Profile Addresses

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1239

---

createProfileContact

▸ createProfileContact(params, payload?, config?): OperationResponse<$201 | $400 | $401 | $404 | $406 | $422>

Operation Method for POST /api/v2/profiles/{profile_id}/contacts

Parameters

Name	Type
params	Object
params.contact_id	string
params.profile_id	string
payload?	Object
payload.data	any
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$201 | $400 | $401 | $404 | $406 | $422>

Tag

KYC Profile Contact Informations

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1166

---

createProfileName

▸ createProfileName(params, payload?, config?): OperationResponse<$201 | $400 | $401 | $404 | $406 | $422>

Operation Method for POST /api/v2/profiles/{profile_id}/names

Parameters

Name	Type
params	Object
params.name_id	string
params.profile_id	string
payload?	Object
payload.data	any
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$201 | $400 | $401 | $404 | $406 | $422>

Tag

KYC Profile Names

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1020

---

createProfileNumber

▸ createProfileNumber(params, payload?, config?): OperationResponse<$201 | $400 | $401 | $404 | $406 | $422>

Operation Method for POST /api/v2/profiles/{profile_id}/numbers

Parameters

Name	Type
params	Object
params.number_id	string
params.profile_id	string
payload?	Object
payload.data	any
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$201 | $400 | $401 | $404 | $406 | $422>

Tag

KYC Profile Numbers

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1093

---

createRelatedEntitieRelatedEntityDesignation

▸ createRelatedEntitieRelatedEntityDesignation(params, payload?, config?): OperationResponse<$201 | $400 | $401 | $404 | $406 | $422>

Operation Method for POST /api/v2/related_entities/{related_entity_id}/related_entity_designations

Parameters

Name	Type
params	Object
params.related_entity_id	string
payload?	Object
payload.data	any
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$201 | $400 | $401 | $404 | $406 | $422>

Tag

Related Entity Designations

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2593

---

delete

▸ delete<T, R, D>(url, config?): Promise<R>

A proxy for the Axios delete function

Type parameters

Name	Type
T	any
R	extends AxiosResponseWithMetaData<any, any> = AxiosResponseWithMetaData<T, any>
D	any

Parameters

Name	Type	Description
url	string	Pathname of the request
config?	AxiosRequestConfig<D>	Additional Axios Request Configuration Overrides

Returns

Promise<R>

An Axios Response with MetaData

See

Axios Documentation

Defined in

src/DocFoxClient.ts:467

---

deleteAdditionalDetail

▸ deleteAdditionalDetail(params, payload?, config?): OperationResponse<$204 | $400 | $401 | $404 | $422>

Operation Method for DELETE /api/v2/additional_details/{additional_detail_id}

Parameters

Name	Type
params	Object
params.additional_detail_id	string
payload?	Object
payload.data	any
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$204 | $400 | $401 | $404 | $422>

Tag

KYC Profile Additional Details

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1341

---

deleteAddresse

▸ deleteAddresse(params, payload?, config?): OperationResponse<$204 | $400 | $401 | $404>

Operation Method for DELETE /api/v2/addresses/{address_id}

Parameters

Name	Type
params	Object
params.address_id	string
payload?	Object
payload.data	any
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$204 | $400 | $401 | $404>

Tag

KYC Profile Addresses

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1268

---

deleteContact

▸ deleteContact(params, payload?, config?): OperationResponse<$204 | $400 | $401 | $404>

Operation Method for DELETE /api/v2/contacts/{contact_id}

Parameters

Name	Type
params	Object
params.contact_id	string
payload?	Object
payload.data	any
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$204 | $400 | $401 | $404>

Tag

KYC Profile Contact Informations

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1195

---

deleteDataRequirementPermission

▸ deleteDataRequirementPermission(params, config?): OperationResponse<$204 | $400 | $401 | $404>

Operation Method for DELETE /api/v2/data_requirement_permissions/{data_requirement_permission_id}

Parameters

Name	Type
params	Object
params.data_requirement_permission_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$204 | $400 | $401 | $404>

Tag

Data Requirement Permissions

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1464

---

deleteKycApplication

▸ deleteKycApplication(params, config?): OperationResponse<$204 | $400 | $401 | $404>

Operation Method for DELETE /api/v2/kyc_applications/{kyc_application_id}

Parameters

Name	Type
params	Object
params.kyc_application_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$204 | $400 | $401 | $404>

Tag

KYC Applications

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:875

---

deleteName

▸ deleteName(params, payload?, config?): OperationResponse<$204 | $400 | $401 | $404>

Operation Method for DELETE /api/v2/names/{name_id}

Parameters

Name	Type
params	Object
params.name_id	string
payload?	Object
payload.data	any
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$204 | $400 | $401 | $404>

Tag

KYC Profile Names

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1049

---

deleteNumber

▸ deleteNumber(params, payload?, config?): OperationResponse<$204 | $400 | $401 | $404 | $422>

Operation Method for DELETE /api/v2/numbers/{number_id}

Parameters

Name	Type
params	Object
params.number_id	string
payload?	Object
payload.data	any
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$204 | $400 | $401 | $404 | $422>

Tag

KYC Profile Numbers

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1122

---

deleteRelatedEntitie

▸ deleteRelatedEntitie(params, config?): OperationResponse<$204 | $400 | $401 | $404 | $422>

Operation Method for DELETE /api/v2/related_entities/{related_entity_id}

Parameters

Name	Type
params	Object
params.related_entity_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$204 | $400 | $401 | $404 | $422>

Tag

Related Entities

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2063

---

deleteRelatedEntityDesignation

▸ deleteRelatedEntityDesignation(params, config?): OperationResponse<$204 | $400 | $401 | $404>

Operation Method for DELETE /api/v2/related_entity_designations/{related_entity_designation_id}

Parameters

Name	Type
params	Object
params.related_entity_designation_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$204 | $400 | $401 | $404>

Tag

Related Entity Designations

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2558

---

get

▸ get<T, R, D>(url, config?): Promise<R>

A proxy for the Axios get function

Type parameters

Name	Type
T	any
R	extends AxiosResponseWithMetaData<any, any> = AxiosResponseWithMetaData<T, any>
D	any

Parameters

Name	Type	Description
url	string	Pathname of the request
config?	AxiosRequestConfig<D>	Additional Axios Request Configuration Overrides

Returns

Promise<R>

An Axios Response with MetaData

See

Axios Documentation

Defined in

src/DocFoxClient.ts:370

---

getAccountAddon

▸ getAccountAddon(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/account_addons/{account_addon_id}

Parameters

Name	Type
params	Object
params.account_addon_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Account Addons

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2643

---

getAccountApplication

▸ getAccountApplication(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/account_applications/{account_application_id}

Parameters

Name	Type
params	Object
params.account_application_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Account Applications

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2870

---

getAccountApplicationAccountSummary

▸ getAccountApplicationAccountSummary(params, config?): OperationResponse<$200 | $404>

Operation Method for GET /api/v2/account_applications/{id}/account_summary

Parameters

Name	Type
params	Object
params.id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $404>

Tag

Account Application Summary

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2811

---

getAccountApplicationAccountSummaryPdf

▸ getAccountApplicationAccountSummaryPdf(params, config?): OperationResponse<$200 | $404>

Operation Method for GET /api/v2/account_applications/{id}/account_summary_pdf

Parameters

Name	Type
params	Object
params.id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $404>

Tag

Account Application Pdf Summary

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2741

---

getAdditionalDetail

▸ getAdditionalDetail(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/additional_details/{additional_detail_id}

Parameters

Name	Type
params	Object
params.additional_detail_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

KYC Profile Additional Details

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1327

---

getAddresse

▸ getAddresse(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/addresses/{address_id}

Parameters

Name	Type
params	Object
params.address_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

KYC Profile Addresses

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1254

---

getAll

▸ getAll<T, R, D>(url, config?): Promise<T[]>

Helper function to simplify the retrieval of all resources for a given path

Type parameters

Name	Type
T	any
R	extends AxiosResponseWithMetaData<any, any> = AxiosResponseWithMetaData<T, any>
D	any

Parameters

Name	Type	Description
url	string	Pathname of the request
config?	AxiosRequestConfig<D>	Additional Axios Request Configuration Overrides

Returns

Promise<T[]>

An Axios Response with MetaData

Defined in

src/DocFoxClient.ts:400

---

getAllFromOperationMethod

▸ getAllFromOperationMethod<O, P, D, C, R, T>(operation, parameters?, payload?, config?): Promise<T>

Helper function to simplify the retrieval of all resources for a given operation

Type parameters

Name	Type
O	extends keyof OperationMethods
P	Omit<Parameters<OperationMethods[O]>[0], "page" | "per_page">
D	Parameters<OperationMethods[O]>[1]
C	Parameters<OperationMethods[O]>[2]
R	extends AxiosResponseWithMetaData<any, any> = Awaited<ReturnType<OperationMethods[O]>>
T	ExtractNestedDataType<R>

Parameters

Name	Type	Description
operation	O	Operation Method to call
parameters?	P	Parameters to pass to the operation excluding page and per_page
payload?	D	Payload to pass to the operation
config?	C	Additional Axios Request Configuration Overrides

Returns

Promise<T>

An array of the extracted data from the response

Defined in

src/DocFoxClient.ts:753

---

getBankAccount

▸ getBankAccount(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/bank_accounts/{bank_account_id}

Parameters

Name	Type
params	Object
params.bank_account_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Bank Account Verification

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2323

---

getBankAccountSchema

▸ getBankAccountSchema(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/bank_account_schemas/{kyc_application_id}

Parameters

Name	Type
params	Object
params.kyc_application_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Bank Account Verification

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2280

---

getBankAccountVerification

▸ getBankAccountVerification(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/bank_account_verifications/{bank_account_verification_id}

Parameters

Name	Type
params	Object
params.bank_account_verification_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Bank Account Verification

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2337

---

getComparisonResult

▸ getComparisonResult(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/comparison_results/{comparison_result_id}

Parameters

Name	Type
params	Object
params.comparison_result_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Comparison Results

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1684

---

getConsumerReportQuerie

▸ getConsumerReportQuerie(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/consumer_report_queries/{id}

Parameters

Name	Type
params	Object
params.id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Consumer Report Query

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2408

---

getConsumerReportQuerieDownload

▸ getConsumerReportQuerieDownload(params, config?): OperationResponse<$302 | $400 | $401 | $404 | $406 | $409>

Operation Method for GET /api/v2/consumer_report_queries/{id}/download

Parameters

Name	Type
params	Object
params.id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$302 | $400 | $401 | $404 | $406 | $409>

Tag

Consumer Report Query

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2422

---

getContact

▸ getContact(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/contacts/{contact_id}

Parameters

Name	Type
params	Object
params.contact_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

KYC Profile Contact Informations

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1181

---

getDataComparison

▸ getDataComparison(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/data_comparisons/{data_comparison_id}

Parameters

Name	Type
params	Object
params.data_comparison_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Data Comparisons

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1628

---

getDataRequirement

▸ getDataRequirement(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/data_requirements/{data_requirement_id}

Parameters

Name	Type
params	Object
params.data_requirement_id	string
params.include?	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Data Requirements

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1572

---

getDataRequirementPermission

▸ getDataRequirementPermission(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/data_requirement_permissions/{data_requirement_permission_id}

Parameters

Name	Type
params	Object
params.data_requirement_permission_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Data Requirement Permissions

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1450

---

getDisclosure

▸ getDisclosure(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/disclosures/{disclosure_id}

Parameters

Name	Type
params	Object
params.disclosure_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Disclosures

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2685

---

getDocument

▸ getDocument(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/documents/{document_id}

Parameters

Name	Type
params	Object
params.document_id	string
params.include?	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Documents

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1892

---

getDocumentFileDownload

▸ getDocumentFileDownload(params, config?): OperationResponse<$302 | $404 | $406 | $410>

Operation Method for GET /api/v2/document_file_downloads/{document_token_id}

Parameters

Name	Type
params	Object
params.document_token_id	Record<string, any>
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$302 | $404 | $406 | $410>

Tag

Download Documents

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1949

---

getDocumentToken

▸ getDocumentToken(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/document_tokens/{document_token_id}

Parameters

Name	Type
params	Object
params.document_token_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Document Tokens

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1935

---

getEvidenceSubmission

▸ getEvidenceSubmission(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/evidence_submissions/{evidence_submission_id}

Parameters

Name	Type
params	Object
params.evidence_submission_id	string
params.include?	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Evidence Submissions

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1719

---

getForm

▸ getForm(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/forms/{form_id}

Parameters

Name	Type
params	Object
params.form_id	string
params.include?	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Forms

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1963

---

getFormDataById

▸ getFormDataById(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/form_data/{form_datum_id}

Parameters

Name	Type
params	Object
params.form_datum_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Form Data

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2006

---

getFormFormData

▸ getFormFormData(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/forms/{form_id}/form_data

Parameters

Name	Type
params	Object
params.form_id	string
params.page?	number
params.per_page?	number
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Form Data

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1977

---

getFormPdfExport

▸ getFormPdfExport(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/form_pdf_exports/{form_pdf_export_id}/

Parameters

Name	Type
params	Object
params.form_pdf_export_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Form PDF Exports

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2495

---

getFormPdfExportDownload

▸ getFormPdfExportDownload(params, config?): OperationResponse<$302 | $400 | $401 | $404 | $406 | $409>

Operation Method for GET /api/v2/form_pdf_exports/{form_pdf_export_id}/download

Parameters

Name	Type
params	Object
params.form_pdf_export_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$302 | $400 | $401 | $404 | $406 | $409>

Tag

Form PDF Exports

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2509

---

getInvitationToken

▸ getInvitationToken(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/invitation_tokens/{invitation_token_id}

Parameters

Name	Type
params	Object
params.invitation_token_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Invitation Tokens

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1400

---

getKycApplication

▸ getKycApplication(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/kyc_applications/{kyc_application_id}

Parameters

Name	Type
params	Object
params.include?	string
params.kyc_application_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

KYC Applications

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:861

---

getKycApplicationRiskRating

▸ getKycApplicationRiskRating(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/kyc_applications/{kyc_application_id}/risk_ratings/{evaluation_id}

Parameters

Name	Type
params	Object
params.evaluation_id	string
params.kyc_application_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Risk Ratings

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2230

---

getKycEntityTemplate

▸ getKycEntityTemplate(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/kyc_entity_templates/{kyc_entity_template_id}

Parameters

Name	Type
params	Object
params.kyc_entity_template_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

KYC Entity Templates

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1600

---

getName

▸ getName(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/names/{name_id}

Parameters

Name	Type
params	Object
params.name_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

KYC Profile Names

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1035

---

getNumber

▸ getNumber(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/numbers/{number_id}

Parameters

Name	Type
params	Object
params.number_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

KYC Profile Numbers

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1108

---

getPdfReportSummarie

▸ getPdfReportSummarie(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/pdf_report_summaries/{pdf_report_summary_id}/

Parameters

Name	Type
params	Object
params.pdf_report_summary_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

PDF Report Summaries

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2110

---

getPdfReportSummarieDownload

▸ getPdfReportSummarieDownload(params, config?): OperationResponse<$302 | $400 | $401 | $404 | $406 | $409>

Operation Method for GET /api/v2/pdf_report_summaries/{pdf_summary_report_id}/download

Parameters

Name	Type
params	Object
params.pdf_report_summary_id	string
params.pdf_summary_report_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$302 | $400 | $401 | $404 | $406 | $409>

Tag

PDF Report Summaries

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2124

---

getProduct

▸ getProduct(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/products/{id}

Parameters

Name	Type
params	Object
params.id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Products

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2713

---

getProfile

▸ getProfile(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/profiles/{profile_id}

Parameters

Name	Type
params	Object
params.include?	string
params.profile_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Profiles

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:992

---

getQualitativeCheck

▸ getQualitativeCheck(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/qualitative_checks/{qualitative_check_id}

Parameters

Name	Type
params	Object
params.qualitative_check_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Qualitative Checks

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1814

---

getRejectionReason

▸ getRejectionReason(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/rejection_reasons/{rejection_reason_id}

Parameters

Name	Type
params	Object
params.rejection_reason_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Rejection Reasons

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1849

---

getRelatedEntitie

▸ getRelatedEntitie(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/related_entities/{related_entity_id}

Parameters

Name	Type
params	Object
params.include?	string
params.related_entity_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Related Entities

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2049

---

getRelatedEntityDesignation

▸ getRelatedEntityDesignation(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/related_entity_designations/{related_entity_designation_id}

Parameters

Name	Type
params	Object
params.related_entity_designation_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Related Entity Designations

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2544

---

getRiskRatingEvaluation

▸ getRiskRatingEvaluation(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/risk_rating_evaluations/{risk_rating_evaluation_id}

Parameters

Name	Type
params	Object
params.risk_rating_evaluation_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Risk Rating Evaluations

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2166

---

getUri

▸ getUri(config?): string

A proxy for the Axios getUri function

Parameters

Name	Type	Description
config?	AxiosRequestConfig<any>	Axios Request Configuration

Returns

string

The URI for the request

See

Axios Documentation

Defined in

src/DocFoxClient.ts:329

---

getUser

▸ getUser(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/users/{user_id}

Parameters

Name	Type
params	Object
params.user_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Users

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2152

---

head

▸ head<T, R, D>(url, config?): Promise<R>

A proxy for the Axios head function

Type parameters

Name	Type
T	any
R	extends AxiosResponseWithMetaData<any, any> = AxiosResponseWithMetaData<T, any>
D	any

Parameters

Name	Type	Description
url	string	Pathname of the request
config?	AxiosRequestConfig<D>	Additional Axios Request Configuration Overrides

Returns

Promise<R>

An Axios Response with MetaData

See

Axios Documentation

Defined in

src/DocFoxClient.ts:498

---

listAccountApplicationAccountAddon

▸ listAccountApplicationAccountAddon(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/account_applications/{account_application_id}/account_addons

Parameters

Name	Type
params	Object
params.account_application_id	string
params.page?	number
params.per_page?	number
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Account Addons

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2629

---

listAccountApplicationDataRequirement

▸ listAccountApplicationDataRequirement(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/account_applications/{account_application_id}/data_requirements

Parameters

Name	Type
params	Object
params.account_application_id	string
params.forms?	boolean
params.page?	number
params.per_page?	number
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Data Requirements

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2776

---

listBankAccountBankAccountVerification

▸ listBankAccountBankAccountVerification(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/bank_accounts/{bank_account_id}/bank_account_verifications

Parameters

Name	Type
params	Object
params.bank_account_id	string
params.page?	number
params.per_page?	number
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Bank Account Verification

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2366

---

listContactDataRequirementPermission

▸ listContactDataRequirementPermission(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/contacts/{contact_information_id}/data_requirement_permissions

Parameters

Name	Type
params	Object
params.contact_information_id	string
params.page?	number
params.per_page?	number
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Data Requirement Permissions

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1429

---

listContactInvitationToken

▸ listContactInvitationToken(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/contacts/{contact_information_id}/invitation_tokens

Parameters

Name	Type
params	Object
params.contact_information_id	string
params.page?	number
params.per_page?	number
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Invitation Tokens

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1371

---

listDataComparisonComparisonResult

▸ listDataComparisonComparisonResult(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/data_comparisons/{data_comparison_id}/comparison_results

Parameters

Name	Type
params	Object
params.data_comparison_id	string
params.page?	number
params.per_page?	number
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Comparison Results

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1670

---

listDataRequirementDataComparison

▸ listDataRequirementDataComparison(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/data_requirements/{data_requirement_id}/data_comparisons

Parameters

Name	Type
params	Object
params.data_requirement_id	string
params.page?	number
params.per_page?	number
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Data Comparisons

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1656

---

listDataRequirementDataRequirementPermission

▸ listDataRequirementDataRequirementPermission(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/data_requirements/{data_requirement_id}/data_requirement_permissions

Parameters

Name	Type
params	Object
params.data_requirement_id	string
params.page?	number
params.per_page?	number
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Data Requirement Permissions

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1493

---

listDataRequirementEvidenceSubmission

▸ listDataRequirementEvidenceSubmission(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/data_requirements/{data_requirement_id}/evidence_submissions

Parameters

Name	Type
params	Object
params.data_requirement_id	string
params.page?	number
params.per_page?	number
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Evidence Submissions

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1698

---

listDisclosure

▸ listDisclosure(params, config?): OperationResponse<$200 | $400 | $401 | $403>

Operation Method for GET /api/v2/disclosures

Parameters

Name	Type
params	Object
params.page?	number
params.per_page?	number
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $403>

Tag

Disclosures

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2671

---

listDocumentDocumentToken

▸ listDocumentDocumentToken(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/documents/{document_id}/document_tokens

Parameters

Name	Type
params	Object
params.document_id	string
params.page?	number
params.per_page?	number
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Document Tokens

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1906

---

listEvidenceSubmissionDocument

▸ listEvidenceSubmissionDocument(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/evidence_submissions/{evidence_submission_id}/documents

Parameters

Name	Type
params	Object
params.evidence_submission_id	string
params.page?	number
params.per_page?	number
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Documents

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1863

---

listEvidenceSubmissionQualitativeCheck

▸ listEvidenceSubmissionQualitativeCheck(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/evidence_submissions/{evidence_submission_id}/qualitative_checks

Parameters

Name	Type
params	Object
params.evidence_submission_id	string
params.page?	number
params.per_page?	number
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Qualitative Checks

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1793

---

listEvidenceSubmissionRejectionReason

▸ listEvidenceSubmissionRejectionReason(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/evidence_submissions/{evidence_submission_id}/rejection_reasons

Parameters

Name	Type
params	Object
params.evidence_submission_id	string
params.page?	number
params.per_page?	number
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Rejection Reasons

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1828

---

listFormFormPdfExport

▸ listFormFormPdfExport(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/forms/{form_id}/form_pdf_exports

Parameters

Name	Type
params	Object
params.form_id	string
params.page?	number
params.per_page?	number
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Form PDF Exports

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2466

---

listKycApplication

▸ listKycApplication(params, config?): OperationResponse<$200 | $400 | $401 | $403>

Operation Method for GET /api/v2/kyc_applications

Parameters

Name	Type
params	Object
params.filter?	string
params.page?	number
params.per_page?	number
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $403>

Tag

KYC Applications

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:832

---

listKycApplicationAccountApplication

▸ listKycApplicationAccountApplication(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/kyc_applications/{kyc_application_id}/account_applications

Parameters

Name	Type
params	Object
params.kyc_application_id	string
params.page?	number
params.per_page?	number
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Account Applications

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2827

---

listKycApplicationBankAccount

▸ listKycApplicationBankAccount(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/kyc_applications/{kyc_application_id}/bank_accounts

Parameters

Name	Type
params	Object
params.kyc_application_id	string
params.page?	number
params.per_page?	number
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Bank Account Verification

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2294

---

listKycApplicationConsumerReportQuerie

▸ listKycApplicationConsumerReportQuerie(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/kyc_applications/{kyc_application_id}/consumer_report_queries

Parameters

Name	Type
params	Object
params.kyc_application_id	string
params.page?	number
params.per_page?	number
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Consumer Report Query

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2387

---

listKycApplicationDataComparison

▸ listKycApplicationDataComparison(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/kyc_applications/{kyc_application_id}/data_comparisons

Parameters

Name	Type
params	Object
params.kyc_application_id	string
params.page?	number
params.per_page?	number
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Data Comparisons

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1614

---

listKycApplicationDataRequirement

▸ listKycApplicationDataRequirement(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/kyc_applications/{kyc_application_id}/data_requirements

Parameters

Name	Type
params	Object
params.forms?	boolean
params.kyc_application_id	string
params.page?	number
params.per_page?	number
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Data Requirements

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1558

---

listKycApplicationPdfReportSummarie

▸ listKycApplicationPdfReportSummarie(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/kyc_applications/{kyc_application_id}/pdf_report_summaries

Parameters

Name	Type
params	Object
params.kyc_application_id	string
params.page?	number
params.per_page?	number
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

PDF Report Summaries

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2077

---

listKycApplicationProfile

▸ listKycApplicationProfile(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/kyc_applications/{kyc_application_id}/profiles

Parameters

Name	Type
params	Object
params.kyc_application_id	string
params.page?	number
params.per_page?	number
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Profiles

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:978

---

listKycApplicationRelatedEntitie

▸ listKycApplicationRelatedEntitie(params, config?): OperationResponse<$200 | $400 | $401 | $404 | $409>

Operation Method for GET /api/v2/kyc_applications/{kyc_application_id}/related_entities

Parameters

Name	Type
params	Object
params.kyc_application_id	string
params.page?	number
params.per_page?	number
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404 | $409>

Tag

Related Entities

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2020

---

listKycApplicationRiskRating

▸ listKycApplicationRiskRating(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/kyc_applications/{kyc_application_id}/risk_ratings

Parameters

Name	Type
params	Object
params.kyc_application_id	string
params.page?	number
params.per_page?	number
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Risk Ratings

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2201

---

listKycApplicationRiskRatingEvaluation

▸ listKycApplicationRiskRatingEvaluation(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/kyc_applications/{kyc_application_id}/risk_rating_evaluations

Parameters

Name	Type
params	Object
params.kyc_application_id	string
params.page?	number
params.per_page?	number
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Risk Rating Evaluations

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2180

---

listKycApplicationRiskRatingsQuestion

▸ listKycApplicationRiskRatingsQuestion(params, config?): OperationResponse<$200 | $404>

Operation Method for GET /api/v2/kyc_applications/{kyc_application_id}/risk_ratings/questions

Parameters

Name	Type
params	Object
params.kyc_application_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $404>

Tag

Risk Ratings

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2259

---

listKycApplicationStatusSummarie

▸ listKycApplicationStatusSummarie(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/kyc_applications/{kyc_application_id}/status_summaries

Parameters

Name	Type
params	Object
params.kyc_application_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Status Summaries

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:964

---

listKycEntityTemplate

▸ listKycEntityTemplate(params, config?): OperationResponse<$200 | $400 | $401 | $403>

Operation Method for GET /api/v2/kyc_entity_templates

Parameters

Name	Type
params	Object
params.page?	number
params.per_page?	number
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $403>

Tag

KYC Entity Templates

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1586

---

listKycEntityTemplateDesignationTemplate

▸ listKycEntityTemplateDesignationTemplate(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/kyc_entity_templates/{kyc_entity_template_id}/designation_templates

Parameters

Name	Type
params	Object
params.kyc_entity_template_id	string
params.page?	number
params.per_page?	number
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Related Entity Designations

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2523

---

listKycEntityTemplateDisclosure

▸ listKycEntityTemplateDisclosure(params, config?): OperationResponse<$200 | $400 | $401 | $403 | $404>

Operation Method for GET /api/v2/kyc_entity_templates/{kyc_entity_template_id}/disclosures

Parameters

Name	Type
params	Object
params.kyc_entity_template_id	string
params.page?	number
params.per_page?	number
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $403 | $404>

Tag

KycEntityTemplates Disclosures

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2762

---

listKycEntityTemplateProduct

▸ listKycEntityTemplateProduct(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/kyc_entity_templates/{kyc_entity_template_id}/products

Parameters

Name	Type
params	Object
params.kyc_entity_template_id	string
params.page?	number
params.per_page?	number
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

KycEntityTemplates Products

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2727

---

listProduct

▸ listProduct(params, config?): OperationResponse<$200 | $400 | $401 | $403>

Operation Method for GET /api/v2/products

Parameters

Name	Type
params	Object
params.page?	number
params.per_page?	number
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $403>

Tag

Products

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2699

---

listProductDisclosure

▸ listProductDisclosure(params, config?): OperationResponse<$200 | $400 | $401 | $403 | $404>

Operation Method for GET /api/v2/products/{product_id}/disclosures

Parameters

Name	Type
params	Object
params.page?	number
params.per_page?	number
params.product_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $403 | $404>

Tag

Product Disclosures

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2657

---

listProductProductAddonsDisclosure

▸ listProductProductAddonsDisclosure(params, config?): OperationResponse<$200 | $400 | $401 | $403>

Operation Method for GET /api/v2/product_product_addons/disclosures

Parameters

Name	Type
params	Object
params.page?	number
params.per_page?	number
params.product_product_addon_ids?	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $403>

Tag

Product Product Addon Disclosures

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2797

---

listProductProductProductAddon

▸ listProductProductProductAddon(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/products/{product_id}/product_product_addons

Parameters

Name	Type
params	Object
params.page?	number
params.per_page?	number
params.product_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Product Addons

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2615

---

listProfileAdditionalDetail

▸ listProfileAdditionalDetail(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/profiles/{profile_id}/additional_details

Parameters

Name	Type
params	Object
params.page?	number
params.per_page?	number
params.profile_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

KYC Profile Additional Details

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1298

---

listProfileAddresse

▸ listProfileAddresse(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/profiles/{profile_id}/addresses

Parameters

Name	Type
params	Object
params.page?	number
params.per_page?	number
params.profile_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

KYC Profile Addresses

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1225

---

listProfileContact

▸ listProfileContact(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/profiles/{profile_id}/contacts

Parameters

Name	Type
params	Object
params.page?	number
params.per_page?	number
params.profile_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

KYC Profile Contact Informations

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1152

---

listProfileDataComparison

▸ listProfileDataComparison(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/profiles/{profile_id}/data_comparisons

Parameters

Name	Type
params	Object
params.page?	number
params.per_page?	number
params.profile_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Data Comparisons

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1642

---

listProfileName

▸ listProfileName(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/profiles/{profile_id}/names

Parameters

Name	Type
params	Object
params.page?	number
params.per_page?	number
params.profile_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

KYC Profile Names

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1006

---

listProfileNumber

▸ listProfileNumber(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/profiles/{profile_id}/numbers

Parameters

Name	Type
params	Object
params.page?	number
params.per_page?	number
params.profile_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

KYC Profile Numbers

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1079

---

listRelatedEntitieRelatedEntityDesignation

▸ listRelatedEntitieRelatedEntityDesignation(params, config?): OperationResponse<$200 | $400 | $401 | $404>

Operation Method for GET /api/v2/related_entities/{related_entity_id}/related_entity_designations

Parameters

Name	Type
params	Object
params.page?	number
params.per_page?	number
params.related_entity_id	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404>

Tag

Related Entity Designations

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2572

---

listUser

▸ listUser(params, config?): OperationResponse<$200 | $400 | $401 | $403>

Operation Method for GET /api/v2/users

Parameters

Name	Type
params	Object
params.page?	number
params.per_page?	number
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $403>

Tag

Users

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2138

---

options

▸ options<T, R, D>(url, config?): Promise<R>

A proxy for the Axios options function

Type parameters

Name	Type
T	any
R	extends AxiosResponseWithMetaData<any, any> = AxiosResponseWithMetaData<T, any>
D	any

Parameters

Name	Type	Description
url	string	Pathname of the request
config?	AxiosRequestConfig<D>	Additional Axios Request Configuration Overrides

Returns

Promise<R>

An Axios Response with MetaData

See

Axios Documentation

Defined in

src/DocFoxClient.ts:529

---

patch

▸ patch<T, R, D>(url, data?, config?): Promise<R>

A proxy for the Axios patch function

Type parameters

Name	Type
T	any
R	extends AxiosResponseWithMetaData<any, any> = AxiosResponseWithMetaData<T, any>
D	any

Parameters

Name	Type	Description
url	string	Pathname of the request
data?	D	Data to send with the request
config?	AxiosRequestConfig<D>	Additional Axios Request Configuration Overrides

Returns

Promise<R>

An Axios Response with MetaData

See

Axios Documentation

Defined in

src/DocFoxClient.ts:625

---

patchForm

▸ patchForm<T, R, D>(url, data?, config?): Promise<R>

A proxy for the Axios patchForm function

Type parameters

Name	Type
T	any
R	extends AxiosResponseWithMetaData<any, any> = AxiosResponseWithMetaData<T, any>
D	any

Parameters

Name	Type	Description
url	string	Pathname of the request
data?	D	Data to send with the request
config?	AxiosRequestConfig<D>	Additional Axios Request Configuration Overrides

Returns

Promise<R>

An Axios Response with MetaData

See

Axios Documentation

Defined in

src/DocFoxClient.ts:721

---

post

▸ post<T, R, D>(url, data?, config?): Promise<R>

A proxy for the Axios post function

Type parameters

Name	Type
T	any
R	extends AxiosResponseWithMetaData<any, any> = AxiosResponseWithMetaData<T, any>
D	any

Parameters

Name	Type	Description
url	string	Pathname of the request
data?	D	Data to send with the request
config?	AxiosRequestConfig<D>	Additional Axios Request Configuration Overrides

Returns

Promise<R>

An Axios Response with MetaData

See

Axios Documentation

Defined in

src/DocFoxClient.ts:561

---

postForm

▸ postForm<T, R, D>(url, data?, config?): Promise<R>

A proxy for the Axios postForm function

Type parameters

Name	Type
T	any
R	extends AxiosResponseWithMetaData<any, any> = AxiosResponseWithMetaData<T, any>
D	any

Parameters

Name	Type	Description
url	string	Pathname of the request
data?	D	Data to send with the request
config?	AxiosRequestConfig<D>	Additional Axios Request Configuration Overrides

Returns

Promise<R>

An Axios Response with MetaData

See

Axios Documentation

Defined in

src/DocFoxClient.ts:657

---

put

▸ put<T, R, D>(url, data?, config?): Promise<R>

A proxy for the Axios put function

Type parameters

Name	Type
T	any
R	extends AxiosResponseWithMetaData<any, any> = AxiosResponseWithMetaData<T, any>
D	any

Parameters

Name	Type	Description
url	string	Pathname of the request
data?	D	Data to send with the request
config?	AxiosRequestConfig<D>	Additional Axios Request Configuration Overrides

Returns

Promise<R>

An Axios Response with MetaData

See

Axios Documentation

Defined in

src/DocFoxClient.ts:593

---

putForm

▸ putForm<T, R, D>(url, data?, config?): Promise<R>

A proxy for the Axios putForm function

Type parameters

Name	Type
T	any
R	extends AxiosResponseWithMetaData<any, any> = AxiosResponseWithMetaData<T, any>
D	any

Parameters

Name	Type	Description
url	string	Pathname of the request
data?	D	Data to send with the request
config?	AxiosRequestConfig<D>	Additional Axios Request Configuration Overrides

Returns

Promise<R>

An Axios Response with MetaData

See

Axios Documentation

Defined in

src/DocFoxClient.ts:689

---

request

▸ request<T, R, D>(config): Promise<R>

A proxy for the Axios request function

Type parameters

Name	Type
T	any
R	extends AxiosResponseWithMetaData<any, any> = AxiosResponseWithMetaData<T, any>
D	any

Parameters

Name	Type	Description
config	AxiosRequestConfig<D>	Axios Request Configuration

Returns

Promise<R>

An Axios Response with MetaData

See

Axios Documentation

Defined in

src/DocFoxClient.ts:346

---

requestAuthentication

▸ requestAuthentication(params, config?): OperationResponse<$200 | $400 | $401>

Operation Method for GET /api/v2/authentications/new

Parameters

Name	Type
params	Object
params.X-Client-Api-Key	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401>

Tag

Authentication

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:804

---

requestToken

▸ requestToken(params, config?): OperationResponse<$200 | $400 | $401>

Operation Method for GET /api/v2/tokens/new

Parameters

Name	Type
params	Object
params.X-Client-Api-Key	string
params.X-Client-Signature	string
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401>

Tag

Authentication

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:818

---

setAuth

▸ setAuth(auth): any

Parameters

Name	Type
auth	AuthTokenInformation

Returns

any

Defined in

src/DocFoxClient.ts:180

▸ setAuth(auth, expiresAt?): any

Parameters

Name	Type
auth	undefined | string
expiresAt?	string | DateTime<boolean> | Date

Returns

any

Defined in

src/DocFoxClient.ts:181

---

setCompatibilityMode

▸ setCompatibilityMode(value): void

Enable or disable compatibility mode which allows URI's which do not start with /api/v2 to be passed to the axios alias functions (get, post, etc)

Parameters

Name	Type	Description
value	boolean	If compatibility mode should be enabled

Returns

void

Defined in

src/DocFoxClient.ts:218

---

unarchiveKycApplication

▸ unarchiveKycApplication(params, payload?, config?): OperationResponse<$200 | $400>

Operation Method for POST /api/v2/kyc_applications/{kyc_application_id}/unarchive

Parameters

Name	Type
params	Object
params.kyc_application_id	string
payload?	Object
payload.data	Record<string, any>
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400>

Tag

KYC Applications

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:949

---

updateAccountApplication

▸ updateAccountApplication(params, payload?, config?): OperationResponse<$200 | $400 | $401 | $404 | $406>

Operation Method for PATCH /api/v2/account_applications/{account_application_id}

Parameters

Name	Type
params	Object
params.account_application_id	string
payload?	Object
payload.data	any
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404 | $406>

Tag

Account Applications

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2884

---

updateAccountApplicationDisclosureAcceptances

▸ updateAccountApplicationDisclosureAcceptances(params, payload?, config?): OperationResponse<$200 | $400 | $401 | $404 | $406>

Operation Method for PATCH /api/v2/account_applications/{id}/disclosure_acceptances

Parameters

Name	Type
params	Object
params.id	string
payload?	Object
payload.data	any
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404 | $406>

Tag

Disclosure Acceptances

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2899

---

updateAdditionalDetail

▸ updateAdditionalDetail(params, payload?, config?): OperationResponse<$200 | $400 | $401 | $404 | $406 | $422>

Operation Method for PATCH /api/v2/additional_details/{additional_detail_id}

Parameters

Name	Type
params	Object
params.additional_detail_id	string
payload?	Object
payload.data	any
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404 | $406 | $422>

Tag

KYC Profile Additional Details

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1356

---

updateAddresse

▸ updateAddresse(params, payload?, config?): OperationResponse<$200 | $400 | $401 | $404 | $406 | $422>

Operation Method for PATCH /api/v2/addresses/{address_id}

Parameters

Name	Type
params	Object
params.address_id	string
payload?	Object
payload.data	any
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404 | $406 | $422>

Tag

KYC Profile Addresses

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1283

---

updateBankAccountVerification

▸ updateBankAccountVerification(params, payload?, config?): OperationResponse<$200 | $400 | $401 | $404 | $406>

Operation Method for PATCH /api/v2/bank_account_verifications/{bank_account_verification_id}

Parameters

Name	Type
params	Object
params.bank_account_verification_id	string
payload?	Object
payload.data	any
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404 | $406>

Tag

Bank Account Verification

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2351

---

updateContact

▸ updateContact(params, payload?, config?): OperationResponse<$200 | $400 | $401 | $404 | $406 | $422>

Operation Method for PATCH /api/v2/contacts/{contact_id}

Parameters

Name	Type
params	Object
params.contact_id	string
payload?	Object
payload.data	any
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404 | $406 | $422>

Tag

KYC Profile Contact Informations

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1210

---

updateEvidenceSubmission

▸ updateEvidenceSubmission(params, payload?, config?): OperationResponse<$200 | $400 | $401 | $404 | $406 | $409>

Operation Method for PATCH /api/v2/evidence_submissions/{evidence_submission_id}

Parameters

Name	Type
params	Object
params.evidence_submission_id	string
params.include?	string
payload?	Object
payload.data	any
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404 | $406 | $409>

Tag

Evidence Submissions

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1733

---

updateEvidenceSubmissionApprove

▸ updateEvidenceSubmissionApprove(params, payload?, config?): OperationResponse<$200 | $400 | $401 | $404 | $406>

Operation Method for PATCH /api/v2/evidence_submissions/{evidence_submission_id}/approve

Parameters

Name	Type
params	Object
params.evidence_submission_id	string
params.include?	string
payload?	Object
payload.data	Record<string, any>
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404 | $406>

Tag

Evidence Submissions

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1763

---

updateEvidenceSubmissionReject

▸ updateEvidenceSubmissionReject(params, payload?, config?): OperationResponse<$200 | $400 | $401 | $404 | $406>

Operation Method for PATCH /api/v2/evidence_submissions/{evidence_submission_id}/reject

Parameters

Name	Type
params	Object
params.evidence_submission_id	string
params.include?	string
payload?	Object
payload.data	Record<string, any>
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404 | $406>

Tag

Evidence Submissions

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1748

---

updateEvidenceSubmissionReplace

▸ updateEvidenceSubmissionReplace(params, payload?, config?): OperationResponse<$200 | $400 | $401 | $404 | $406>

Operation Method for PATCH /api/v2/evidence_submissions/{evidence_submission_id}/replace

Parameters

Name	Type
params	Object
params.evidence_submission_id	string
params.include?	string
payload?	Object
payload.data	Record<string, any>
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404 | $406>

Tag

Evidence Submissions

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1778

---

updateInvitationToken

▸ updateInvitationToken(params, payload?, config?): OperationResponse<$200 | $400 | $401 | $404 | $406 | $409>

Operation Method for PATCH /api/v2/invitation_tokens/{invitation_token_id}

Parameters

Name	Type
params	Object
params.contact_information_id	string
params.invitation_token_id	string
payload?	Object
payload.data	any
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404 | $406 | $409>

Tag

Invitation Tokens

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1414

---

updateKycApplicationApprove

▸ updateKycApplicationApprove(params, payload?, config?): OperationResponse<$200 | $400 | $401 | $404 | $406 | $422>

Operation Method for PATCH /api/v2/kyc_applications/{kyc_application_id}/approve

Parameters

Name	Type
params	Object
params.kyc_application_id	string
payload?	Object
payload.data	Record<string, any>
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404 | $406 | $422>

Tag

KYC Applications

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:889

---

updateKycApplicationRiskRating

▸ updateKycApplicationRiskRating(params, payload?, config?): OperationResponse<$200 | $400 | $401 | $404 | $406>

Operation Method for PATCH /api/v2/kyc_applications/{kyc_application_id}/risk_ratings/{evaluation_id}

Parameters

Name	Type
params	Object
params.evaluation_id	string
params.kyc_application_id	string
payload?	Object
payload.data	any
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404 | $406>

Tag

Risk Ratings

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2244

---

updateKycApplicationTransfer

▸ updateKycApplicationTransfer(params, payload?, config?): OperationResponse<$200 | $400 | $401 | $404 | $406 | $422>

Operation Method for PATCH /api/v2/kyc_applications/{kyc_application_id}/transfer

Parameters

Name	Type
params	Object
params.kyc_application_id	string
payload?	Object
payload.data	Record<string, any>
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404 | $406 | $422>

Tag

KYC Applications

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:919

---

updateKycApplicationUnapprove

▸ updateKycApplicationUnapprove(params, payload?, config?): OperationResponse<$200 | $400 | $401 | $404 | $406 | $422>

Operation Method for PATCH /api/v2/kyc_applications/{kyc_application_id}/unapprove

Parameters

Name	Type
params	Object
params.kyc_application_id	string
payload?	Object
payload.data	Record<string, any>
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404 | $406 | $422>

Tag

KYC Applications

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:904

---

updateName

▸ updateName(params, payload?, config?): OperationResponse<$200 | $400 | $401 | $404 | $406 | $422>

Operation Method for PATCH /api/v2/names/{name_id}

Parameters

Name	Type
params	Object
params.name_id	string
payload?	Object
payload.data	any
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404 | $406 | $422>

Tag

KYC Profile Names

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1064

---

updateNumber

▸ updateNumber(params, payload?, config?): OperationResponse<$200 | $400 | $401 | $404 | $406 | $422>

Operation Method for PATCH /api/v2/numbers/{number_id}

Parameters

Name	Type
params	Object
params.number_id	string
payload?	Object
payload.data	any
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404 | $406 | $422>

Tag

KYC Profile Numbers

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:1137

---

updateOnboardingInvitation

▸ updateOnboardingInvitation(params, payload?, config?): OperationResponse<$200 | $400 | $401 | $404 | $406 | $422>

Operation Method for PATCH /api/v2/onboarding_invitations/{kyc_application_id}

Parameters

Name	Type
params	Object
params.kyc_application_id	string
payload?	Object
payload.data	any
config?	AxiosRequestConfig<any>

Returns

OperationResponse<$200 | $400 | $401 | $404 | $406 | $422>

Tag

Onboarding Invitation

See

DocFox Documentation

Defined in

src/DocFoxClient.ts:2451

---

error

▸ Static error(message?, response?): DocFoxError

Parameters

Name	Type
message?	string
response?	AxiosResponse<any, any>

Returns

DocFoxError

Defined in

src/DocFoxClient.ts:2916

---

errorFromAuth

▸ Static errorFromAuth(message?, response?): DocFoxAuthenticationError

Parameters

Name	Type
message?	string
response?	AxiosResponse<any, any>

Returns

DocFoxAuthenticationError

Defined in

src/DocFoxClient.ts:2920