Class: default
A class which wraps all known methods of the Sumsub API
Constructors
constructor
• new default(token, secret)
Creates a new instance of the SumsubClient
Parameters
| Name | Type | Description |
|---|---|---|
token | string | The API Token generated from the Sumsub Dashboard |
secret | string | The API Secret generated from the Sumsub Dashboard |
Defined in
Properties
GenerationTimeStamp
▪ Static Readonly GenerationTimeStamp: "2024-03-04T12:20:39.405Z"
The ISO 8601 Timestamp of when this client was generated
Defined in
Error Codes
Errors
▪ Static Readonly Errors: Object
See
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
Generic Methods
delete
▸ delete<T, R, D>(url, config?): Promise<R>
Make a generic HTTP Delete request to the Sumsub API
Type parameters
| Name | Type |
|---|---|
T | any |
R | AxiosResponse<T, any> |
D | any |
Parameters
| Name | Type | Description |
|---|---|---|
url | string | The URL to make the request to relative to the base URL |
config? | AxiosRequestConfig<D> | The Axios request configuration |
Returns
Promise<R>
The Axios response
Defined in
get
▸ get<T, R, D>(url, config?): Promise<R>
Make a generic HTTP Get request to the Sumsub API
Type parameters
| Name | Type |
|---|---|
T | any |
R | AxiosResponse<T, any> |
D | any |
Parameters
| Name | Type | Description |
|---|---|---|
url | string | The URL to make the request to relative to the base URL |
config? | AxiosRequestConfig<D> | The Axios request configuration |
Returns
Promise<R>
The Axios response
Defined in
head
▸ head<T, R, D>(url, config?): Promise<R>
Make a generic HTTP Head request to the Sumsub API
Type parameters
| Name | Type |
|---|---|
T | any |
R | AxiosResponse<T, any> |
D | any |
Parameters
| Name | Type | Description |
|---|---|---|
url | string | The URL to make the request to relative to the base URL |
config? | AxiosRequestConfig<D> | The Axios request configuration |
Returns
Promise<R>
The Axios response
Defined in
options
▸ options<T, R, D>(url, config?): Promise<R>
Make a generic HTTP Options request to the Sumsub API
Type parameters
| Name | Type |
|---|---|
T | any |
R | AxiosResponse<T, any> |
D | any |
Parameters
| Name | Type | Description |
|---|---|---|
url | string | The URL to make the request to relative to the base URL |
config? | AxiosRequestConfig<D> | The Axios request configuration |
Returns
Promise<R>
The Axios response
Defined in
patch
▸ patch<T, R, D>(url, data?, config?): Promise<R>
Make a generic HTTP Patch request to the Sumsub API
Type parameters
| Name | Type |
|---|---|
T | any |
R | AxiosResponse<T, any> |
D | any |
Parameters
| Name | Type | Description |
|---|---|---|
url | string | The URL to make the request to relative to the base URL |
data? | any | The data to send in the request |
config? | AxiosRequestConfig<D> | The Axios request configuration |
Returns
Promise<R>
The Axios response
Defined in
post
▸ post<T, R, D>(url, data?, config?): Promise<R>
Make a generic HTTP Post request to the Sumsub API
Type parameters
| Name | Type |
|---|---|
T | any |
R | AxiosResponse<T, any> |
D | any |
Parameters
| Name | Type | Description |
|---|---|---|
url | string | The URL to make the request to relative to the base URL |
data? | any | The data to send in the request |
config? | AxiosRequestConfig<D> | The Axios request configuration |
Returns
Promise<R>
The Axios response
Defined in
put
▸ put<T, R, D>(url, data?, config?): Promise<R>
Make a generic HTTP Put request to the Sumsub API
Type parameters
| Name | Type |
|---|---|
T | any |
R | AxiosResponse<T, any> |
D | any |
Parameters
| Name | Type | Description |
|---|---|---|
url | string | The URL to make the request to relative to the base URL |
data? | any | The data to send in the request |
config? | AxiosRequestConfig<D> | The Axios request configuration |
Returns
Promise<R>
The Axios response
Defined in
request
▸ request<T, R, D>(config): Promise<R>
Make a generic request to the Sumsub API
Type parameters
| Name | Type |
|---|---|
T | any |
R | AxiosResponse<T, any> |
D | any |
Parameters
| Name | Type | Description |
|---|---|---|
config | AxiosRequestConfig<D> | The Axios request configuration |
Returns
Promise<R>
The Axios response
Defined in
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
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
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
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
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
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
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
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
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
Defined in
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
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
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
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
Defined in
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
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
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
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
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
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
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
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
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
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
Defined in
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
Defined in
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
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
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
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
Defined in
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
Defined in
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
Defined in
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
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
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
Defined in
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
Defined in
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
Defined in
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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