Class: default

Constructors

constructor

• new default(token, secret)

Parameters

Name	Type
token	string
secret	string

Defined in

src/client.ts:2713

Properties

GenerationTimeStamp

▪ Static Readonly GenerationTimeStamp: "2024-03-04T12:20:39.405Z"

The ISO 8601 Timestamp of when this client was generated

Defined in

src/client.ts:5137

Methods

delete

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

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
url	string
config?	AxiosRequestConfig<D>

Returns

Promise<R>

Defined in

src/client.ts:2761

---

get

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

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
url	string
config?	AxiosRequestConfig<D>

Returns

Promise<R>

Defined in

src/client.ts:2754

---

head

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

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
url	string
config?	AxiosRequestConfig<D>

Returns

Promise<R>

Defined in

src/client.ts:2768

---

options

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

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
url	string
config?	AxiosRequestConfig<D>

Returns

Promise<R>

Defined in

src/client.ts:2775

---

patch

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

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
url	string
data?	any
config?	AxiosRequestConfig<D>

Returns

Promise<R>

Defined in

src/client.ts:2798

---

post

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

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
url	string
data?	any
config?	AxiosRequestConfig<D>

Returns

Promise<R>

Defined in

src/client.ts:2782

---

put

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

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
url	string
data?	any
config?	AxiosRequestConfig<D>

Returns

Promise<R>

Defined in

src/client.ts:2790

---

request

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

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
config	AxiosRequestConfig<D>

Returns

Promise<R>

Defined in

src/client.ts:2748

Error Codes

Errors

▪ Static Readonly Errors: Object

See

Error Codes API Reference

Type declaration

Name	Type	Description
1000	string	Duplicate document (image, video) was uploaded. Exact equality is taken into account.
1001	string	Applicant contains too many documents. Adding new is not allowed.
1002	string	Uploaded file is too big (more than 64MB).
1003	string	Uploaded file is empty (0 bytes).
1004	string	File is corrupted or of incorrect format (e.g. PDF file is uploaded as JPEG).
1005	string	Unsupported file format (e.g. a TIFF image).
1006	string	Applicant is being checked. Adding new data is not allowed.
1007	string	The file size must meet the file upload requirements specified in the global settings.
1008	string	Applicant is marked as deleted/inactive. No action is allowed to change the status.
1009	string	Applicant is rejected with the FINAL rejection type. Adding new data/files is not allowed.
1010	string	Attempt to upload the document outside of the applicant level set/set of required documents.
3000	string	Attempt to change the status of the applicant against the logic — the applicant is already in the required state.
4000	string	Invalid format of the X-App-Token value.
4001	string	App token does not exist (e.g. test env. token used on production).
4002	string	Private part of the token (after dot) does not match public part.
4003	string	Signature encoded value does not match the request content.
4004	string	X-App-Access-Ts does not match the number of seconds since Unix Epoch in UTC.
4005	string	Invalid authentication header values were provided.
4006	string	Not all required authorization headers were provided.
4007	string	Invalid authentication parameters were provided.
5000	string	Attempt to blocklist the applicant that is already blocklisted.
5001	string	Attempt to whitelist the applicant that is already whitelisted.

Defined in

src/client.ts:5087

Handle applicant actions

accessTokensGenerateAccessToken

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

Creates an applicant action token.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	AccessTokensGenerateAccessTokenRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Generate access token API Reference

Defined in

src/client.ts:3944

---

applicantActionsAddImageToPaymentMethod

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

Adds an image to the payment method.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantActionsAddImageToPaymentMethodRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Add image to payment method API Reference

Defined in

src/client.ts:4178

---

applicantActionsAddPaymentMethodInformation

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

Adds additional information to the payment method.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantActionsAddPaymentMethodInformationRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Add payment method information API Reference

Defined in

src/client.ts:4119

---

applicantActionsCreateApplicantAction

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

Creates an applicant action.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantActionsCreateApplicantActionRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Create applicant action API Reference

Defined in

src/client.ts:4028

---

applicantActionsGetActionInformation

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

Returns information about the applicant action checks.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantActionsGetActionInformationRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Get action information API Reference

Defined in

src/client.ts:4002

---

applicantActionsGetApplicantActions

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

Returns a list of applicant actions.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantActionsGetApplicantActionsRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Get applicant actions API Reference

Defined in

src/client.ts:3973

---

applicantActionsGetBankCardImage

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

Returns an original bank card image.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantActionsGetBankCardImageRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Get bank card image API Reference

Defined in

src/client.ts:4149

---

applicantActionsRequestActionCheck

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

Requests an applicant action check.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantActionsRequestActionCheckRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Request action check API Reference

Defined in

src/client.ts:4061

---

applicantActionsSubmission

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

Creates an action with transaction information.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantActionsSubmissionRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Submission API Reference

Defined in

src/client.ts:4087

---

standaloneGetAvailableTokens

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

Returns available tokens.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Get available tokens API Reference

Defined in

src/client.ts:4237

---

standaloneStandaloneCryptoAnalysis

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

Initiates standalone crypto analysis.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	StandaloneStandaloneCryptoAnalysisRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Standalone crypto analysis API Reference

Defined in

src/client.ts:4207

Integration

auditTrailEventsAuditTrailEvents

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

Returns audit trail events.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	AuditTrailEventsAuditTrailEventsRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Audit trail events API Reference

Defined in

src/client.ts:2833

---

statusApiHealth

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

Use this method to check the operational status of the API.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

API health API Reference

Defined in

src/client.ts:2864

Know Your Business

applicantsAddApplicantAsBeneficiary

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

Adds an existing individual applicant as a beneficiary.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantsAddApplicantAsBeneficiaryRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Add applicant as beneficiary API Reference

Defined in

src/client.ts:4260

---

applicantsChangeCompanyData

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

Changes company data.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantsChangeCompanyDataRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Change company data API Reference

Defined in

src/client.ts:4318

---

applicantsRemoveApplicantFromBeneficiaryList

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

Removes the applicant from the list of company beneficial owners.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantsRemoveApplicantFromBeneficiaryListRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Remove applicant from beneficiary list API Reference

Defined in

src/client.ts:4291

---

checksGetAdditionalCompanyCheckData

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

Returns company check results.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ChecksGetAdditionalCompanyCheckDataRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Get additional company check data API Reference

Defined in

src/client.ts:4360

Manage Non-Doc verification

applicantsConfirmApplicantData

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

Confirms applicant data.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantsConfirmApplicantDataRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Confirm applicant data API Reference

Defined in

src/client.ts:4467

---

applicantsSubmitApplicantData

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

Sends applicant data for no-document verification.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantsSubmitApplicantDataRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Submit applicant data API Reference

Defined in

src/client.ts:4439

---

checksGetApplicantData

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

Returns the applicant data for Non-Doc verification.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ChecksGetApplicantDataRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Get applicant data API Reference

Defined in

src/client.ts:4497

Perform transaction monitoring

applicantsSubmitTransactionForExistingApplicant

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

Initiates transaction processing.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantsSubmitTransactionForExistingApplicantRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Submit transaction for existing applicant API Reference

Defined in

src/client.ts:4524

---

applicantsSubmitTransactionForNonExistingApplicant

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

Initiates transaction processing for non-existing applicants.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantsSubmitTransactionForNonExistingApplicantRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Submit transaction for non-existing applicant API Reference

Defined in

src/client.ts:4563

---

kytAddNotes

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

Adds notes to transactions.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	KytAddNotesRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Add notes API Reference

Defined in

src/client.ts:4849

---

kytAddTags

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

Adds tags to transactions.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	KytAddTagsRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Add tags API Reference

Defined in

src/client.ts:4767

---

kytApproveAndRejectTransaction

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

Approves or rejects transactions.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	KytApproveAndRejectTransactionRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Approve and reject transaction API Reference

Defined in

src/client.ts:4713

---

kytBulkTransactionImport

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

Imports a list of transactions.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	KytBulkTransactionImportRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Bulk transaction import API Reference

Defined in

src/client.ts:4627

---

kytChangeTransactionProperties

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

Updates transaction properties.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	KytChangeTransactionPropertiesRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Change transaction properties API Reference

Defined in

src/client.ts:4657

---

kytEditNotes

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

Updates a note.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	KytEditNotesRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Edit notes API Reference

Defined in

src/client.ts:4877

---

kytGetNotes

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

Returns transaction notes.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	KytGetNotesRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Get notes API Reference

Defined in

src/client.ts:4823

---

kytGetTags

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

Returns a list of transaction tags.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	KytGetTagsRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Get tags API Reference

Defined in

src/client.ts:4741

---

kytGetTransactionInformation

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

Returns transaction information.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	KytGetTransactionInformationRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Get transaction information API Reference

Defined in

src/client.ts:4601

---

kytReScoreTransaction

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

Re-scores transactions.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	KytReScoreTransactionRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Re-score transaction API Reference

Defined in

src/client.ts:4687

---

kytRemoveNotes

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

Removes notes from transactions.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	KytRemoveNotesRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Remove notes API Reference

Defined in

src/client.ts:4906

---

kytRemoveTags

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

Removes tags from transactions.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	KytRemoveTagsRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Remove tags API Reference

Defined in

src/client.ts:4795

Use Travel Rule

kytConfirmTransactionOwnership

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

Confirms that the specified transaction belongs to your exchange (VASP).

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	KytConfirmTransactionOwnershipRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Confirm transaction ownership API Reference

Defined in

src/client.ts:5016

---

kytEnrichingTransactionWithTravelRule

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

Enriches transaction with the Travel Rule data.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	KytEnrichingTransactionWithTravelRuleRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Enriching transaction with Travel Rule API Reference

Defined in

src/client.ts:4988

---

kytMoveTransactionToAnotherApplicant

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

Moves transaction to the specified applicant.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	KytMoveTransactionToAnotherApplicantRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Move transaction to another applicant API Reference

Defined in

src/client.ts:4961

---

kytPatchTransactionWithChainTransactionId

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

Updates information from the blockchain.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	KytPatchTransactionWithChainTransactionIdRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Patch transaction with chain transaction ID API Reference

Defined in

src/client.ts:4933

---

kytRemoveTransactionOwnership

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

Removes the ownership from a previously confirmed transaction.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	KytRemoveTransactionOwnershipRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Remove transaction ownership API Reference

Defined in

src/client.ts:5042

---

vaspsGetAvailableVasPs

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

Returns a list of VASPs from the Sumsub VASP directory.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	VaspsGetAvailableVasPsRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Get available VASPs API Reference

Defined in

src/client.ts:5068

Work with Video Ident results

inspectionsGetVideoCallData

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

Returns the video call results.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	InspectionsGetVideoCallDataRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Get video call data API Reference

Defined in

src/client.ts:4386

---

videoIdentGetVideoCallMedia

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

Returns video call media.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	VideoIdentGetVideoCallMediaRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Get video call media API Reference

Defined in

src/client.ts:4412

Work with applicants

applicantFraudNetworksGetApplicantFraudNetworks

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

Returns all fraud networks by applicantId.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantFraudNetworksGetApplicantFraudNetworksRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Get applicant fraud networks API Reference

Defined in

src/client.ts:3781

---

applicantFraudNetworksGetFraudNetworkById

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

Returns fraud network by networkId.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantFraudNetworksGetFraudNetworkByIdRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Get fraud network by ID API Reference

Defined in

src/client.ts:3811

---

applicantFraudNetworksGetFraudNetworks

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

Returns fraud networks.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantFraudNetworksGetFraudNetworksRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Get fraud networks API Reference

Defined in

src/client.ts:3754

---

applicantsAddAndOverwriteCustomApplicantTags

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

Adds and overwrites custom tags in applicant profiles.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantsAddAndOverwriteCustomApplicantTagsRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Add and overwrite custom applicant tags API Reference

Defined in

src/client.ts:3268

---

applicantsAddApplicantToBlocklist

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

Add an applicant to blocklist.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantsAddApplicantToBlocklistRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Add applicant to blocklist API Reference

Defined in

src/client.ts:3352

---

applicantsAddCustomApplicantTags

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

Adds custom tags to applicant profiles.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantsAddCustomApplicantTagsRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Add custom applicant tags API Reference

Defined in

src/client.ts:3240

---

applicantsAddIdDocument

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

Adds an identification document to be verified.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantsAddIdDocumentRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Add ID document API Reference

Defined in

src/client.ts:2977

---

applicantsChangeInformationExtractedBySumsub

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

Changes extracted information.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantsChangeInformationExtractedBySumsubRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Change information extracted by Sumsub API Reference

Defined in

src/client.ts:3049

---

applicantsChangeProvidedInformation

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

Updates information provided when creating an applicant.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantsChangeProvidedInformationRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Change provided information API Reference

Defined in

src/client.ts:3006

---

applicantsChangeRequiredDocumentSet

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

Changes the list of required documents.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantsChangeRequiredDocumentSetRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Change required document set API Reference

Defined in

src/client.ts:2923

---

applicantsChangeTopLevelInformation

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

Changes existing verification level configuration.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantsChangeTopLevelInformationRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Change top-level information API Reference

Defined in

src/client.ts:3089

---

applicantsCreateApplicant

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

Creates an applicant.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantsCreateApplicantRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Create applicant API Reference

Defined in

src/client.ts:2887

---

applicantsDeactivateApplicantProfile

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

Deactivates an applicant profile.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantsDeactivateApplicantProfileRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Deactivate applicant profile API Reference

Defined in

src/client.ts:3462

---

applicantsGetApplicantData

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

Returns applicant information.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantsGetApplicantDataRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Get applicant data API Reference

Defined in

src/client.ts:3489

---

applicantsGetApplicantDataExternalUserId

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

Returns applicant information based on the provided externalUserId.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantsGetApplicantDataExternalUserIdRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Get applicant data (externalUserId) API Reference

Defined in

src/client.ts:3515

---

applicantsGetApplicantReviewStatus

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

Returns applicant review status.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantsGetApplicantReviewStatusRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Get applicant review status API Reference

Defined in

src/client.ts:3541

---

applicantsGetApplicantVerificationStepsStatus

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

Returns information about the documents or separate verification step results.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantsGetApplicantVerificationStepsStatusRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Get applicant verification steps status API Reference

Defined in

src/client.ts:3567

---

applicantsGetAvailableApplicantLevels

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

Returns a list of verification levels.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Get available applicant levels API Reference

Defined in

src/client.ts:3895

---

applicantsGetRequiredIdDocuments

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

Returns the list of required documents.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantsGetRequiredIdDocumentsRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Get required ID documents API Reference

Defined in

src/client.ts:2951

---

applicantsImportApplicantWithImagesByArchive

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

Imports applicant data and images including associated review results.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantsImportApplicantWithImagesByArchiveRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Import applicant with images by archive API Reference

Defined in

src/client.ts:3153

---

applicantsImportApplicants

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

Imports applicants.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantsImportApplicantsRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Import applicants API Reference

Defined in

src/client.ts:3123

---

applicantsRemoveCustomApplicantTags

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

Removes all custom tags from applicant profiles.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantsRemoveCustomApplicantTagsRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Remove custom applicant tags API Reference

Defined in

src/client.ts:3296

---

applicantsRequestApplicantCheck

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

Initiates a check of the applicant profile.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantsRequestApplicantCheckRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Request applicant check API Reference

Defined in

src/client.ts:3324

---

applicantsResetApplicantProfile

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

Marks documents uploaded by the applicant as inactive and deletes all statuses assigned earlier.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantsResetApplicantProfileRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Reset applicant profile API Reference

Defined in

src/client.ts:3380

---

applicantsResetVerificationStep

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

Resets the specified verification step.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantsResetVerificationStepRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Reset verification step API Reference

Defined in

src/client.ts:3406

---

applicantsSetApplicantRiskLevel

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

Sets the risk level for the given applicant.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantsSetApplicantRiskLevelRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Set applicant risk level API Reference

Defined in

src/client.ts:3211

---

applicantsSetReviewForApplicantInSandbox

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

Simulates a verification reposnose.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ApplicantsSetReviewForApplicantInSandboxRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Set review for applicant in sandbox API Reference

Defined in

src/client.ts:3179

---

checksGetAdditionalPoAData

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

Returns PoA data.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ChecksGetAdditionalPoADataRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Get additional PoA data API Reference

Defined in

src/client.ts:3918

---

checksGetEmailConfirmationCheckResults

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

Returns email confirmation check results.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ChecksGetEmailConfirmationCheckResultsRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Get email confirmation check results API Reference

Defined in

src/client.ts:3676

---

checksGetIpCheckResults

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

Returns IP check results.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ChecksGetIpCheckResultsRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Get IP check results API Reference

Defined in

src/client.ts:3728

---

checksGetPhoneConfirmationCheckResults

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

Returns phone confirmation check results.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ChecksGetPhoneConfirmationCheckResultsRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Get phone confirmation check results API Reference

Defined in

src/client.ts:3702

---

checksGetTinSsnCheckResults

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

Returns TIN (SSN) check results.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ChecksGetTinSsnCheckResultsRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Get TIN (SSN) check results API Reference

Defined in

src/client.ts:3650

---

checksPerformNameCrossValidation

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

Performs a name cross validation.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ChecksPerformNameCrossValidationRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Perform name cross validation API Reference

Defined in

src/client.ts:3837

---

inspectionsGetDocumentImages

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

Returns document images.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	InspectionsGetDocumentImagesRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Get document images API Reference

Defined in

src/client.ts:3623

---

inspectionsMarkImageAsInactive

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

Marks uploaded images as deleted.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	InspectionsMarkImageAsInactiveRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Mark image as inactive API Reference

Defined in

src/client.ts:3433

---

moderationStatesClarifyRejectionReason

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

Returns rejection reason clarification.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	ModerationStatesClarifyRejectionReasonRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Clarify rejection reason API Reference

Defined in

src/client.ts:3597

---

sdkIntegrationsGenerateExternalWebSdkLink

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

Creates a link to WebSDK for the specified applicant.

Type parameters

Name	Type
T	any
R	AxiosResponse<T, any>
D	any

Parameters

Name	Type
request	SdkIntegrationsGenerateExternalWebSdkLinkRequest
config?	AxiosRequestConfig<D>

Returns

Promise<R>

See

Generate external WebSDK link API Reference

Defined in

src/client.ts:3865