openapi.city
Sign in

Sumsub

Identity verification and KYC platform

docs.sumsub.com ↗
Version
1.0
OpenAPI
3.0.3
Endpoints
82
Schemas
78
87
Quality
Updated
3 days ago
Identity identity kyc verification
Use this API in your AI agent

Query structured spec data via REST or MCP. Get exactly what your agent needs.

Get API Key

Server URLs

https://api.sumsub.com

Endpoints

Clear filters
GET POST PUT PATCH DELETE

Accesstoken 2 endpoints

POST /resources/accessTokens/behavior

Creates an access token to apply Fisherman per applicant session.

operationId: AccessToken_generateFishermanToken

Request Body

application/json
schema AccessTokenGenerateFishermanTokenRequest
Property Type Required
sessionId string required
ttlInSecs integer optional
userPlatformEventType string required
multipart/form-data
schema AccessTokenGenerateFishermanTokenRequest1
Property Type Required
sessionId string required
ttlInSecs integer optional
userPlatformEventType string required

Responses

200

OK
POST /resources/accessTokens/behavior
POST /resources/applicants/-/kyt/txns/-/data?accessToken={accessToken}

Confirms that the platform event on the applicant side is completed.

operationId: AccessToken_confirmPlatformEvent

Parameters

Name In Required Type Description
accessToken path required string

Access token that you have received at the first step of the flow.

Request Body

application/json
schema AccessTokenConfirmPlatformEventRequest
Property Type Required
txnId string required
applicant object required
└ fullName string required
└ externalUserId string required
userPlatformEventInfo object required
└ failure boolean optional
multipart/form-data
schema AccessTokenConfirmPlatformEventRequest1
Property Type Required
txnId string required
applicant object required
└ fullName string required
└ externalUserId string required
userPlatformEventInfo object required
└ failure boolean optional

Responses

200

OK
POST /resources/applicants/-/kyt/txns/-/data?accessToken={accessToken}

Analysis 1 endpoints

POST /resources/standalone/crypto/cryptoSourceOfFunds

Initiates standalone crypto analysis.

operationId: Analysis_standaloneCryptoInitiation

Request Body

application/json
schema AnalysisStandaloneCryptoInitiationRequest
Property Type Required
txn string optional
address string required
tokenId string optional
currency string required
direction string required
multipart/form-data
schema AnalysisStandaloneCryptoInitiationRequest1
Property Type Required
txn string optional
address string required
tokenId string optional
currency string required
direction string required

Responses

200

OK
POST /resources/standalone/crypto/cryptoSourceOfFunds

Applicant 25 endpoints

POST /resources/applicantActions/-/forApplicant/{applicantId}/?levelName=paymentSource

Creates an action to process a payment source and to confirm the owner of the payment method.

operationId: Applicant_createPaymentSourceActions

Parameters

Name In Required Type Description
applicantId path required string

An unique applicant identifier.
levelName query required string

A verification level name for which you want to create a payment source action.

Request Body

application/json
schema ApplicantCreatePaymentSourceActionsRequest
Property Type Required
paymentSource object optional
└ fixedInfo object optional
└ type string optional
└ email string optional
└ fullName string optional
└ institutionName string optional
└ accountIdentifier string optional
externalActionId string optional
multipart/form-data
schema ApplicantCreatePaymentSourceActionsRequest1
Property Type Required
paymentSource object optional
└ fixedInfo object optional
└ type string optional
└ email string optional
└ fullName string optional
└ institutionName string optional
└ accountIdentifier string optional
externalActionId string optional

Responses

200

200
POST /resources/applicantActions/-/forApplicant/{applicantId}/?levelName=paymentSource
POST /resources/applicantActions/-/forApplicant/{applicantId}/cryptoSourceOfFunds

Creates an action with transaction information.

operationId: Applicant_createCryptoSourceOfFunds

Parameters

Name In Required Type Description
applicantId path required string

A unique applicant identifier.

Request Body

application/json
schema ApplicantCreateCryptoSourceOfFundsRequest
Property Type Required
txn string optional
address string required
tokenId string optional
currency string required
direction string required
multipart/form-data
schema ApplicantCreateCryptoSourceOfFundsRequest1
Property Type Required
txn string optional
address string required
tokenId string optional
currency string required
direction string required

Responses

200

OK
POST /resources/applicantActions/-/forApplicant/{applicantId}/cryptoSourceOfFunds
POST /resources/applicantActions/-/forApplicant/{applicantId}/paymentMethod

Submits a payment method.

operationId: Applicant_submitPaymentMethod

Parameters

Name In Required Type Description
X-External-Action-Id header required string

Use externalActionId if you intend to initialize SDK for that particular action.
requireSelfie query optional boolean

Sets the video selfie at requiredIdDocs for the action.
applicantId path required string

A unique applicant identifier.

Responses

200

OK
POST /resources/applicantActions/-/forApplicant/{applicantId}/paymentMethod
POST /resources/applicantActions/-/forApplicant/{applicantId}?levelName={levelName}

Creates an applicant action.

operationId: Applicant_createAction

Parameters

Name In Required Type Description
applicantId path required string

A unique aplicant identifier.
levelName query required string

A name of the level configured in the dashboard.

Request Body

application/json
schema ApplicantCreateActionRequest
Property Type Required
email string optional
phone string optional
paymentMethod object optional
└ data object optional
└ requiredIdDoc object optional
└ number string optional
└ lastName string optional
└ firstName string optional
└ txnAmount string optional
└ issuedDate string optional
└ middleName string optional
└ type string required
└ subType string optional
externalActionId string required
multipart/form-data
schema ApplicantCreateActionRequest1
Property Type Required
email string optional
phone string optional
paymentMethod object optional
└ data object optional
└ requiredIdDoc object optional
└ number string optional
└ lastName string optional
└ firstName string optional
└ txnAmount string optional
└ issuedDate string optional
└ middleName string optional
└ type string required
└ subType string optional
externalActionId string required

Responses

200

OK
POST /resources/applicantActions/-/forApplicant/{applicantId}?levelName={levelName}
POST /resources/applicantActions/{actionId}/images

Adds an image to the payment method.

operationId: Applicant_addImageToPaymentMethod

Parameters

Name In Required Type Description
actionId path required string

A unique applicant action identifier.

Request Body

application/json
schema ApplicantAddImageToPaymentMethodRequest
Property Type Required
content string required
metadata object required
└ country string required
└ idDocType string required
multipart/form-data
schema ApplicantAddImageToPaymentMethodRequest1
Property Type Required
content string required
metadata object required
└ country string required
└ idDocType string required

Responses

200

OK
POST /resources/applicantActions/{actionId}/images
POST /resources/applicantActions/{actionId}/paymentMethod

Adds additional information to the payment method.

operationId: Applicant_addPaymentMethodInformation

Parameters

Name In Required Type Description
actionId path required string

A unique applicant action identifier.

Request Body

application/json
schema ApplicantAddPaymentMethodInformationRequest
Property Type Required
data object optional
└ requiredIdDoc object optional
└ number string optional
└ lastName string optional
└ firstName string optional
└ txnAmount string optional
└ issuedDate string optional
└ middleName string optional
type string required
subType string optional
multipart/form-data
schema ApplicantAddPaymentMethodInformationRequest1
Property Type Required
data object optional
└ requiredIdDoc object optional
└ number string optional
└ lastName string optional
└ firstName string optional
└ txnAmount string optional
└ issuedDate string optional
└ middleName string optional
type string required
subType string optional

Responses

200

OK
POST /resources/applicantActions/{actionId}/paymentMethod
POST /resources/applicantActions/{actionId}/review/status/pending

Requests an applicant action check.

operationId: Applicant_requestActionCheck

Parameters

Name In Required Type Description
actionId path required string

A unique applicant action identifier.

Responses

200

OK
POST /resources/applicantActions/{actionId}/review/status/pending
POST /resources/applicants/-/applicantImport

Imports applicant data and images including associated review results.

operationId: Applicant_importByArchive

Request Body

application/json
schema ApplicantImportByArchiveRequest
Property Type Required
content string optional
multipart/form-data
schema ApplicantImportByArchiveRequest1
Property Type Required
content string optional

Responses

200

OK
POST /resources/applicants/-/applicantImport
POST /resources/applicants/-/ingestCompleted?levelName={levelName}

Imports applicants.

operationId: Applicant_importCompleted

Parameters

Name In Required Type Description
levelName query optional string

A verification level name. Case-sensitive and must be created in the same environment. If contains reserved characters (e.g., @, +", white spaces as %20), it should be URL-encoded, otherwise you may get signature mismatch.

Request Body

application/json
schema ApplicantImportCompletedRequest
Property Type Required
info object optional
└ dob string optional
└ tin string optional
└ gender string optional
└ country string optional
└ lastName string optional
└ addresses array optional
└ town string optional
└ state string optional
└ street string optional
└ country string optional
└ postCode string optional
└ subStreet string optional
└ flatNumber string optional
└ buildingName string optional
└ buildingNumber string optional
└ firstName string optional
└ legalName string optional
└ lastNameEn string optional
└ middleName string optional
└ firstNameEn string optional
└ nationality string optional
└ middleNameEn string optional
└ placeOfBirth string optional
└ stateOfBirth string optional
└ countryOfBirth string optional
review object optional
└ review object optional
└ reviewAnswer string optional
└ clientComment string optional
└ reviewRejectType string optional
└ moderationComment string optional
└ createDate string optional
└ reviewDate string optional
└ reviewStatus string optional
externalUserId string optional
multipart/form-data
schema ApplicantImportCompletedRequest1
Property Type Required
info object optional
└ dob string optional
└ tin string optional
└ gender string optional
└ country string optional
└ lastName string optional
└ addresses array optional
└ town string optional
└ state string optional
└ street string optional
└ country string optional
└ postCode string optional
└ subStreet string optional
└ flatNumber string optional
└ buildingName string optional
└ buildingNumber string optional
└ firstName string optional
└ legalName string optional
└ lastNameEn string optional
└ middleName string optional
└ firstNameEn string optional
└ nationality string optional
└ middleNameEn string optional
└ placeOfBirth string optional
└ stateOfBirth string optional
└ countryOfBirth string optional
review object optional
└ review object optional
└ reviewAnswer string optional
└ clientComment string optional
└ reviewRejectType string optional
└ moderationComment string optional
└ createDate string optional
└ reviewDate string optional
└ reviewStatus string optional
externalUserId string optional

Responses

200

OK
POST /resources/applicants/-/ingestCompleted?levelName={levelName}
POST /resources/applicants/-/kyt/txns/-/data

Initiates transaction processing for non-existing applicants.

operationId: Applicant_submitTransactionForNonExisting

Parameters

Name In Required Type Description
levelName query required string

A verification level name. Case-sensitive and has to be created in the same environment. If contains reserved characters (e.g., @, +", white spaces as %20), it should be URL-encoded, otherwise you may get signature mismatch.

Request Body

application/json
schema ApplicantSubmitTransactionForNonExistingRequest
Property Type Required
info object required
└ type string optional
└ amount number required
└ direction string required
└ cryptoParams object optional
└ attemptId string required
└ cryptoChain string optional
└ outputIndex integer optional
└ currencyCode string required
└ currencyType string optional
└ paymentTxnId string optional
└ paymentDetails string optional
└ amountInDefaultCurrency number optional
type string optional
props object optional
txnId string required
txnDate string optional
applicant object required
└ type string required
└ device object optional
└ coords object optional
└ lat number optional
└ lon number optional
└ accuracy string optional
└ ipInfo object optional
└ ip string optional
└ asn integer optional
└ lat number optional
└ lon number optional
└ asnOrg string optional
└ riskyAsn boolean optional
└ countryCode3 string optional
└ address object optional
└ town string optional
└ state string optional
└ street string optional
└ country string optional
└ postCode string optional
└ subStreet string optional
└ flatNumber string optional
└ buildingName string optional
└ buildingNumber string optional
└ platform string optional
└ sessionId string optional
└ userAgent string optional
└ acceptLang string optional
└ fingerprint string optional
└ sessionAgeMs integer optional
└ address object optional
└ town string optional
└ state string optional
└ street string optional
└ country string optional
└ postCode string optional
└ subStreet string optional
└ flatNumber string optional
└ buildingName string optional
└ buildingNumber string optional
└ fullName string required
└ paymentMethod object optional
└ type string optional
└ 2faUsed boolean optional
└ 3dsUsed boolean optional
└ accountId string optional
└ issuingCountry string optional
└ externalUserId string required
└ institutionInfo object optional
└ code string optional
└ name string optional
└ address object optional
└ town string optional
└ state string optional
└ street string optional
└ country string optional
└ postCode string optional
└ subStreet string optional
└ flatNumber string optional
└ buildingName string optional
└ buildingNumber string optional
└ internalId string optional
sourceKey string optional
counterparty object required
└ type string required
└ device object optional
└ coords object optional
└ lat number optional
└ lon number optional
└ accuracy string optional
└ ipInfo object optional
└ ip string optional
└ asn integer optional
└ lat number optional
└ lon number optional
└ asnOrg string optional
└ riskyAsn boolean optional
└ countryCode3 string optional
└ address object optional
└ town string optional
└ state string optional
└ street string optional
└ country string optional
└ postCode string optional
└ subStreet string optional
└ flatNumber string optional
└ buildingName string optional
└ buildingNumber string optional
└ platform string optional
└ sessionId string optional
└ userAgent string optional
└ acceptLang string optional
└ fingerprint string optional
└ sessionAgeMs integer optional
└ address object optional
└ town string optional
└ state string optional
└ street string optional
└ country string optional
└ postCode string optional
└ subStreet string optional
└ flatNumber string optional
└ buildingName string optional
└ buildingNumber string optional
└ fullName string required
└ paymentMethod object optional
└ type string optional
└ 2faUsed boolean optional
└ 3dsUsed boolean optional
└ accountId string optional
└ issuingCountry string optional
└ externalUserId string required
└ institutionInfo object optional
└ code string optional
└ name string optional
└ address object optional
└ town string optional
└ state string optional
└ street string optional
└ country string optional
└ postCode string optional
└ subStreet string optional
└ flatNumber string optional
└ buildingName string optional
└ buildingNumber string optional
└ internalId string optional
multipart/form-data
schema ApplicantSubmitTransactionForNonExistingRequest1
Property Type Required
info object required
└ type string optional
└ amount number required
└ direction string required
└ cryptoParams object optional
└ attemptId string required
└ cryptoChain string optional
└ outputIndex integer optional
└ currencyCode string required
└ currencyType string optional
└ paymentTxnId string optional
└ paymentDetails string optional
└ amountInDefaultCurrency number optional
type string optional
props object optional
txnId string required
txnDate string optional
applicant object required
└ type string required
└ device object optional
└ coords object optional
└ lat number optional
└ lon number optional
└ accuracy string optional
└ ipInfo object optional
└ ip string optional
└ asn integer optional
└ lat number optional
└ lon number optional
└ asnOrg string optional
└ riskyAsn boolean optional
└ countryCode3 string optional
└ address object optional
└ town string optional
└ state string optional
└ street string optional
└ country string optional
└ postCode string optional
└ subStreet string optional
└ flatNumber string optional
└ buildingName string optional
└ buildingNumber string optional
└ platform string optional
└ sessionId string optional
└ userAgent string optional
└ acceptLang string optional
└ fingerprint string optional
└ sessionAgeMs integer optional
└ address object optional
└ town string optional
└ state string optional
└ street string optional
└ country string optional
└ postCode string optional
└ subStreet string optional
└ flatNumber string optional
└ buildingName string optional
└ buildingNumber string optional
└ fullName string required
└ paymentMethod object optional
└ type string optional
└ 2faUsed boolean optional
└ 3dsUsed boolean optional
└ accountId string optional
└ issuingCountry string optional
└ externalUserId string required
└ institutionInfo object optional
└ code string optional
└ name string optional
└ address object optional
└ town string optional
└ state string optional
└ street string optional
└ country string optional
└ postCode string optional
└ subStreet string optional
└ flatNumber string optional
└ buildingName string optional
└ buildingNumber string optional
└ internalId string optional
sourceKey string optional
counterparty object required
└ type string required
└ device object optional
└ coords object optional
└ lat number optional
└ lon number optional
└ accuracy string optional
└ ipInfo object optional
└ ip string optional
└ asn integer optional
└ lat number optional
└ lon number optional
└ asnOrg string optional
└ riskyAsn boolean optional
└ countryCode3 string optional
└ address object optional
└ town string optional
└ state string optional
└ street string optional
└ country string optional
└ postCode string optional
└ subStreet string optional
└ flatNumber string optional
└ buildingName string optional
└ buildingNumber string optional
└ platform string optional
└ sessionId string optional
└ userAgent string optional
└ acceptLang string optional
└ fingerprint string optional
└ sessionAgeMs integer optional
└ address object optional
└ town string optional
└ state string optional
└ street string optional
└ country string optional
└ postCode string optional
└ subStreet string optional
└ flatNumber string optional
└ buildingName string optional
└ buildingNumber string optional
└ fullName string required
└ paymentMethod object optional
└ type string optional
└ 2faUsed boolean optional
└ 3dsUsed boolean optional
└ accountId string optional
└ issuingCountry string optional
└ externalUserId string required
└ institutionInfo object optional
└ code string optional
└ name string optional
└ address object optional
└ town string optional
└ state string optional
└ street string optional
└ country string optional
└ postCode string optional
└ subStreet string optional
└ flatNumber string optional
└ buildingName string optional
└ buildingNumber string optional
└ internalId string optional

Responses

200

OK
POST /resources/applicants/-/kyt/txns/-/data
POST /resources/applicants/{applicantId}/agreement

Adds a consent to the applicant profile.

operationId: Applicant_addConsentToProfile

Parameters

Name In Required Type Description
applicantId path required string

A unique identifier of an applicant profile to which a consent should be added.

Request Body

application/json
schema ApplicantAddConsentToProfileRequest
Property Type Required
records array required
└ content string optional
acceptedAt string optional
residenceCountry string optional
multipart/form-data
schema ApplicantAddConsentToProfileRequest1
Property Type Required
records array required
└ content string optional
acceptedAt string optional
residenceCountry string optional

Responses

200

OK
POST /resources/applicants/{applicantId}/agreement
POST /resources/applicants/{applicantId}/blacklist?note={note}

Add an applicant to blocklist.

operationId: Applicant_addToBlocklist

Parameters

Name In Required Type Description
note query required string

A note indicating the reason for blocklisting the applicant profile.
applicantId path required string

A unique applicant identifier.

Responses

200

OK
POST /resources/applicants/{applicantId}/blacklist?note={note}
POST /resources/applicants/{applicantId}/ekyc/confirm/{confirmationid}

Confirms the applicant data with the otp code or via oAuth.

operationId: Applicant_confirmData

Parameters

Name In Required Type Description
applicantId path required string

A unique applicant identifier.
confirmationId path required string

A confirmation identifier from the submission response.

Request Body

application/json
schema ApplicantConfirmDataRequest
Property Type Required
otp object optional
└ code string required
oauth object optional
└ completeUrl string required
multipart/form-data
schema ApplicantConfirmDataRequest1
Property Type Required
otp object optional
└ code string required
oauth object optional
└ completeUrl string required

Responses

200

OK
POST /resources/applicants/{applicantId}/ekyc/confirm/{confirmationid}
POST /resources/applicants/{applicantId}/info/companyInfo/beneficiaries

Adds an existing individual applicant as a beneficiary.

operationId: Applicant_addBeneficiary

Parameters

Name In Required Type Description
applicantId path required string

A unique company applicant identifier.

Request Body

application/json
schema ApplicantAddBeneficiaryRequest
Property Type Required
type string required
applicant object required
└ id string optional
positions array optional
applicantId string required
multipart/form-data
schema ApplicantAddBeneficiaryRequest1
Property Type Required
type string required
applicant object required
└ id string optional
positions array optional
applicantId string required

Responses

200

OK
POST /resources/applicants/{applicantId}/info/companyInfo/beneficiaries
POST /resources/applicants/{applicantId}/info/idDoc

Adds an identification document to the verification flow.

operationId: Applicant_addIdDocument

Parameters

Name In Required Type Description
X-Return-Doc-Warnings header required boolean

true / false
applicantId path required string

A unique applicant identifier.

Request Body

application/json
schema ApplicantAddIdDocumentRequest
Property Type Required
content string optional
metadata object optional
└ dob string optional
└ number string optional
└ country string required
└ lastName string optional
└ firstName string optional
└ idDocType string required
└ issuedDate string optional
└ middleName string optional
└ validUntil string optional
└ idDocSubType string optional
└ placeOfBirth string optional
multipart/form-data
schema ApplicantAddIdDocumentRequest1
Property Type Required
content string optional
metadata object optional
└ dob string optional
└ number string optional
└ country string required
└ lastName string optional
└ firstName string optional
└ idDocType string required
└ issuedDate string optional
└ middleName string optional
└ validUntil string optional
└ idDocSubType string optional
└ placeOfBirth string optional

Responses

200

OK
POST /resources/applicants/{applicantId}/info/idDoc
POST /resources/applicants/{applicantId}/kyt/txns/-/data

Initiates transaction processing.

operationId: Applicant_submitTransactionData

Parameters

Name In Required Type Description
applicantId path required string

A unique identification number of the applicant who passed user verification (KYC). If you do no have such an applicant, use Submit transaction for non-existing applicant instead.

Request Body

application/json
schema ApplicantSubmitTransactionDataRequest
Property Type Required
info object required
└ type string optional
└ amount number required
└ direction string required
└ cryptoParams object optional
└ attemptId string required
└ cryptoChain string optional
└ outputIndex integer optional
└ currencyCode string required
└ currencyType string optional
└ paymentTxnId string optional
└ paymentDetails string optional
└ amountInDefaultCurrency number optional
type string optional
props object optional
└ customTxnLimit string optional
txnId string required
txnDate string optional
applicant object required
└ type string required
└ device object optional
└ coords object optional
└ lat number optional
└ lon number optional
└ accuracy string optional
└ ipInfo object optional
└ ip string optional
└ asn integer optional
└ lat number optional
└ lon number optional
└ asnOrg string optional
└ riskyAsn boolean optional
└ countryCode3 string optional
└ address object optional
└ town string optional
└ state string optional
└ street string optional
└ country string optional
└ postCode string optional
└ subStreet string optional
└ flatNumber string optional
└ buildingName string optional
└ buildingNumber string optional
└ platform string optional
└ sessionId string optional
└ userAgent string optional
└ acceptLang string optional
└ fingerprint string optional
└ sessionAgeMs integer optional
└ address object optional
└ town string optional
└ state string optional
└ street string optional
└ country string optional
└ postCode string optional
└ subStreet string optional
└ flatNumber string optional
└ buildingName string optional
└ buildingNumber string optional
└ fullName string required
└ paymentMethod object optional
└ type string optional
└ 2faUsed boolean optional
└ 3dsUsed boolean optional
└ accountId string optional
└ issuingCountry string optional
└ externalUserId string required
└ institutionInfo object optional
└ code string optional
└ name string optional
└ address object optional
└ town string optional
└ state string optional
└ street string optional
└ country string optional
└ postCode string optional
└ subStreet string optional
└ flatNumber string optional
└ buildingName string optional
└ buildingNumber string optional
└ internalId string optional
sourceKey string optional
counterparty object required
└ type string required
└ device object optional
└ coords object optional
└ lat number optional
└ lon number optional
└ accuracy string optional
└ ipInfo object optional
└ ip string optional
└ asn integer optional
└ lat number optional
└ lon number optional
└ asnOrg string optional
└ riskyAsn boolean optional
└ countryCode3 string optional
└ address object optional
└ town string optional
└ state string optional
└ street string optional
└ country string optional
└ postCode string optional
└ subStreet string optional
└ flatNumber string optional
└ buildingName string optional
└ buildingNumber string optional
└ platform string optional
└ sessionId string optional
└ userAgent string optional
└ acceptLang string optional
└ fingerprint string optional
└ sessionAgeMs integer optional
└ address object optional
└ town string optional
└ state string optional
└ street string optional
└ country string optional
└ postCode string optional
└ subStreet string optional
└ flatNumber string optional
└ buildingName string optional
└ buildingNumber string optional
└ fullName string required
└ paymentMethod object optional
└ type string optional
└ 2faUsed boolean optional
└ 3dsUsed boolean optional
└ accountId string optional
└ issuingCountry string optional
└ externalUserId string required
└ institutionInfo object optional
└ code string optional
└ name string optional
└ address object optional
└ town string optional
└ state string optional
└ street string optional
└ country string optional
└ postCode string optional
└ subStreet string optional
└ flatNumber string optional
└ buildingName string optional
└ buildingNumber string optional
└ internalId string optional
multipart/form-data
schema ApplicantSubmitTransactionDataRequest1
Property Type Required
info object required
└ type string optional
└ amount number required
└ direction string required
└ cryptoParams object optional
└ attemptId string required
└ cryptoChain string optional
└ outputIndex integer optional
└ currencyCode string required
└ currencyType string optional
└ paymentTxnId string optional
└ paymentDetails string optional
└ amountInDefaultCurrency number optional
type string optional
props object optional
└ customTxnLimit string optional
txnId string required
txnDate string optional
applicant object required
└ type string required
└ device object optional
└ coords object optional
└ lat number optional
└ lon number optional
└ accuracy string optional
└ ipInfo object optional
└ ip string optional
└ asn integer optional
└ lat number optional
└ lon number optional
└ asnOrg string optional
└ riskyAsn boolean optional
└ countryCode3 string optional
└ address object optional
└ town string optional
└ state string optional
└ street string optional
└ country string optional
└ postCode string optional
└ subStreet string optional
└ flatNumber string optional
└ buildingName string optional
└ buildingNumber string optional
└ platform string optional
└ sessionId string optional
└ userAgent string optional
└ acceptLang string optional
└ fingerprint string optional
└ sessionAgeMs integer optional
└ address object optional
└ town string optional
└ state string optional
└ street string optional
└ country string optional
└ postCode string optional
└ subStreet string optional
└ flatNumber string optional
└ buildingName string optional
└ buildingNumber string optional
└ fullName string required
└ paymentMethod object optional
└ type string optional
└ 2faUsed boolean optional
└ 3dsUsed boolean optional
└ accountId string optional
└ issuingCountry string optional
└ externalUserId string required
└ institutionInfo object optional
└ code string optional
└ name string optional
└ address object optional
└ town string optional
└ state string optional
└ street string optional
└ country string optional
└ postCode string optional
└ subStreet string optional
└ flatNumber string optional
└ buildingName string optional
└ buildingNumber string optional
└ internalId string optional
sourceKey string optional
counterparty object required
└ type string required
└ device object optional
└ coords object optional
└ lat number optional
└ lon number optional
└ accuracy string optional
└ ipInfo object optional
└ ip string optional
└ asn integer optional
└ lat number optional
└ lon number optional
└ asnOrg string optional
└ riskyAsn boolean optional
└ countryCode3 string optional
└ address object optional
└ town string optional
└ state string optional
└ street string optional
└ country string optional
└ postCode string optional
└ subStreet string optional
└ flatNumber string optional
└ buildingName string optional
└ buildingNumber string optional
└ platform string optional
└ sessionId string optional
└ userAgent string optional
└ acceptLang string optional
└ fingerprint string optional
└ sessionAgeMs integer optional
└ address object optional
└ town string optional
└ state string optional
└ street string optional
└ country string optional
└ postCode string optional
└ subStreet string optional
└ flatNumber string optional
└ buildingName string optional
└ buildingNumber string optional
└ fullName string required
└ paymentMethod object optional
└ type string optional
└ 2faUsed boolean optional
└ 3dsUsed boolean optional
└ accountId string optional
└ issuingCountry string optional
└ externalUserId string required
└ institutionInfo object optional
└ code string optional
└ name string optional
└ address object optional
└ town string optional
└ state string optional
└ street string optional
└ country string optional
└ postCode string optional
└ subStreet string optional
└ flatNumber string optional
└ buildingName string optional
└ buildingNumber string optional
└ internalId string optional

Responses

200

OK
POST /resources/applicants/{applicantId}/kyt/txns/-/data
POST /resources/applicants/{applicantId}/moveToLevel

Changes the list of required documents.

operationId: Applicant_changeRequiredDocumentSet

Parameters

Name In Required Type Description
name query required string

A verification level name. Case-sensitive and must be created in the same environment. If contains reserved characters (e.g., @, +", white spaces as %20), it should be URL-encoded, otherwise you may get signature mismatch.
applicantId path required string

A unique applicant identifier.

Responses

200

OK
POST /resources/applicants/{applicantId}/moveToLevel
POST /resources/applicants/{applicantId}/requiredIdDocs

Returns the list of required documents.

operationId: Applicant_getRequiredIdDocs

Parameters

Name In Required Type Description
applicantId path required string

A unique applicant identifier.

Responses

200

OK
POST /resources/applicants/{applicantId}/requiredIdDocs
POST /resources/applicants/{applicantId}/reset

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

operationId: Applicant_resetProfile

Parameters

Name In Required Type Description
applicantId path required string

A unique applicant identifier.

Responses

200

OK
POST /resources/applicants/{applicantId}/reset
POST /resources/applicants/{applicantId}/resetStep/{idDocSetType}

Resets the specified verification step.

operationId: Applicant_resetVerificationStep

Parameters

Name In Required Type Description
applicantId path required string

A unique applicant identifier.
idDocSetType path required string

A step name to reset.

Responses

200

OK
POST /resources/applicants/{applicantId}/resetStep/{idDocSetType}
POST /resources/applicants/{applicantId}/status/pending?reason={reason}

Initiates a check of the applicant profile.

operationId: Applicant_initiateApplicantCheck

Parameters

Name In Required Type Description
reason query optional string

A note indicating the reason for checking the applicant profile.
applicantId path required string

A unique applicant identifier.

Responses

200

OK
POST /resources/applicants/{applicantId}/status/pending?reason={reason}
POST /resources/applicants/{applicantId}/status/testCompleted

Simulates a verification reposnose.

operationId: Applicant_sandboxVerificationResponse

Parameters

Name In Required Type Description
applicantId path required string

A unique applicant identifier.

Request Body

application/json
schema ApplicantSandboxVerificationResponseRequest
Property Type Required
rejectLabels array required
reviewAnswer string required
clientComment string optional
reviewRejectType string optional
moderationComment string optional
multipart/form-data
schema ApplicantSandboxVerificationResponseRequest1
Property Type Required
rejectLabels array required
reviewAnswer string required
clientComment string optional
reviewRejectType string optional
moderationComment string optional

Responses

200

OK
POST /resources/applicants/{applicantId}/status/testCompleted
POST /resources/applicants/{applicantId}/tags

Adds and overwrites custom tags in applicant profiles.

operationId: Applicant_addCustomTags

Parameters

Name In Required Type Description
applicantId path required string

A unique applicant identifier.

Request Body

application/json
schema ApplicantAddCustomTagsRequest2
Property Type Required
RAW_BODY array optional
multipart/form-data
schema ApplicantAddCustomTagsRequest3
Property Type Required
RAW_BODY array optional

Responses

200

OK
POST /resources/applicants/{applicantId}/tags
POST /resources/applicants/{applicantId}/tags/add

Adds custom tags to applicant profiles.

operationId: Applicant_addCustomTags

Parameters

Name In Required Type Description
applicantId path required string

A unique applicant identifier.

Request Body

application/json
schema ApplicantAddCustomTagsRequest
Property Type Required
RAW_BODY array optional
multipart/form-data
schema ApplicantAddCustomTagsRequest1
Property Type Required
RAW_BODY array optional

Responses

200

OK
POST /resources/applicants/{applicantId}/tags/add
POST /resources/kyt/txns/{txnId}/applicantId/{applicantId}

Moves transaction to the specified applicant.

operationId: Applicant_moveTransactionToAnotherApplicant

Parameters

Name In Required Type Description
txnId path required string

A unique transaction identifier.
applicantId path required string

A unique applicant identifier who should own the transaction.

Responses

200

200
POST /resources/kyt/txns/{txnId}/applicantId/{applicantId}

Note 1 endpoints

POST /resources/kyt/txns/notes

Adds notes to transactions.

operationId: Note_addToTransaction

Request Body

application/json
schema NoteAddToTransactionRequest
Property Type Required
note string required
tags array optional
txnId string required
multipart/form-data
schema NoteAddToTransactionRequest1
Property Type Required
note string required
tags array optional
txnId string required

Responses

200

OK
POST /resources/kyt/txns/notes

Tag 1 endpoints

POST /resources/kyt/txns/{id}/tags

Adds tags to transactions.

operationId: Tag_addTransactionTags

Parameters

Name In Required Type Description
id path required string

A unique transaction identifier.

Request Body

application/json
schema TagAddTransactionTagsRequest
Property Type Required
RAW_BODY array optional
multipart/form-data
schema TagAddTransactionTagsRequest1
Property Type Required
RAW_BODY array optional

Responses

200

OK
POST /resources/kyt/txns/{id}/tags

Token 1 endpoints

POST /resources/accessTokens

Creates an applicant action token.

operationId: Token_createActionToken

Parameters

Name In Required Type Description
ttlInSecs query optional string

A lifespan of a token in seconds. Default value is 10 mins.
userId query required string

An external user ID which will be bound to the token.
externalActionId query required string

An external action ID which will be bound to the token.
levelName query required string

The name of the verification level.

Responses

200

OK
POST /resources/accessTokens

Transaction 5 endpoints

POST /resources/kyt/misc/txns/import

Imports a list of transactions.

operationId: Transaction_bulkImport

Parameters

Name In Required Type Description
ignoreErrors query optional boolean
  • true — all valid transactions will be created and returned, errors will be ignored during the processing and listed in the response.
  • false (default) — valid transactions will be created up to the first detected error. The response will only contain the error on which the processing was interrupted.
scoreSavedTxns query optional boolean

Allows you to control whether scoring should be run on imported transactions or not:<ul><li>true (default) — start scoring after import.</li><li>false — do not start scoring after import.</li></ul>

Request Body

application/json
schema TransactionBulkImportRequest
Property Type Required
data object required
└ info object optional
└ type string optional
└ amount number required
└ direction string required
└ cryptoParams object optional
└ attemptId string required
└ cryptoChain string optional
└ outputIndex integer optional
└ currencyCode string required
└ currencyType string optional
└ paymentTxnId string optional
└ paymentDetails string optional
└ amountInDefaultCurrency number optional
└ type string optional
└ props string optional
└ txnId string required
└ txnDate string optional
└ applicant object optional
└ type string required
└ device object optional
└ coords object optional
└ ipInfo object optional
└ address object optional
└ platform string optional
└ sessionId string optional
└ userAgent string optional
└ acceptLang string optional
└ fingerprint string optional
└ sessionAgeMs integer optional
└ address object optional
└ town string optional
└ state string optional
└ street string optional
└ country string optional
└ postCode string optional
└ subStreet string optional
└ flatNumber string optional
└ buildingName string optional
└ buildingNumber string optional
└ fullName string required
└ paymentMethod object optional
└ type string optional
└ 2faUsed boolean optional
└ 3dsUsed boolean optional
└ accountId string optional
└ issuingCountry string optional
└ externalUserId string required
└ institutionInfo object optional
└ code string optional
└ name string optional
└ address object optional
└ internalId string optional
└ sourceKey string optional
└ counterparty object optional
└ type string required
└ device object optional
└ coords object optional
└ ipInfo object optional
└ address object optional
└ platform string optional
└ sessionId string optional
└ userAgent string optional
└ acceptLang string optional
└ fingerprint string optional
└ sessionAgeMs integer optional
└ address object optional
└ town string optional
└ state string optional
└ street string optional
└ country string optional
└ postCode string optional
└ subStreet string optional
└ flatNumber string optional
└ buildingName string optional
└ buildingNumber string optional
└ fullName string required
└ paymentMethod object optional
└ type string optional
└ 2faUsed boolean optional
└ 3dsUsed boolean optional
└ accountId string optional
└ issuingCountry string optional
└ externalUserId string required
└ institutionInfo object optional
└ code string optional
└ name string optional
└ address object optional
└ internalId string optional
applicantId string required
multipart/form-data
schema TransactionBulkImportRequest1
Property Type Required
data object required
└ info object optional
└ type string optional
└ amount number required
└ direction string required
└ cryptoParams object optional
└ attemptId string required
└ cryptoChain string optional
└ outputIndex integer optional
└ currencyCode string required
└ currencyType string optional
└ paymentTxnId string optional
└ paymentDetails string optional
└ amountInDefaultCurrency number optional
└ type string optional
└ props string optional
└ txnId string required
└ txnDate string optional
└ applicant object optional
└ type string required
└ device object optional
└ coords object optional
└ ipInfo object optional
└ address object optional
└ platform string optional
└ sessionId string optional
└ userAgent string optional
└ acceptLang string optional
└ fingerprint string optional
└ sessionAgeMs integer optional
└ address object optional
└ town string optional
└ state string optional
└ street string optional
└ country string optional
└ postCode string optional
└ subStreet string optional
└ flatNumber string optional
└ buildingName string optional
└ buildingNumber string optional
└ fullName string required
└ paymentMethod object optional
└ type string optional
└ 2faUsed boolean optional
└ 3dsUsed boolean optional
└ accountId string optional
└ issuingCountry string optional
└ externalUserId string required
└ institutionInfo object optional
└ code string optional
└ name string optional
└ address object optional
└ internalId string optional
└ sourceKey string optional
└ counterparty object optional
└ type string required
└ device object optional
└ coords object optional
└ ipInfo object optional
└ address object optional
└ platform string optional
└ sessionId string optional
└ userAgent string optional
└ acceptLang string optional
└ fingerprint string optional
└ sessionAgeMs integer optional
└ address object optional
└ town string optional
└ state string optional
└ street string optional
└ country string optional
└ postCode string optional
└ subStreet string optional
└ flatNumber string optional
└ buildingName string optional
└ buildingNumber string optional
└ fullName string required
└ paymentMethod object optional
└ type string optional
└ 2faUsed boolean optional
└ 3dsUsed boolean optional
└ accountId string optional
└ issuingCountry string optional
└ externalUserId string required
└ institutionInfo object optional
└ code string optional
└ name string optional
└ address object optional
└ internalId string optional
applicantId string required

Responses

200

OK
POST /resources/kyt/misc/txns/import
POST /resources/kyt/txns/{id}/-/score

Re-scores transactions.

operationId: Transaction_reScore

Parameters

Name In Required Type Description
id path required string

A unique transaction identification number.

Responses

200

OK
POST /resources/kyt/txns/{id}/-/score
POST /resources/kyt/txns/{id}/review/status/completed

Approves or rejects transactions.

operationId: Transaction_approveReject

Parameters

Name In Required Type Description
id path required string

A unique transaction identification number.

Request Body

application/json
schema TransactionApproveRejectRequest
Property Type Required
reviewAnswer string optional
multipart/form-data
schema TransactionApproveRejectRequest1
Property Type Required
reviewAnswer string optional

Responses

200

OK
POST /resources/kyt/txns/{id}/review/status/completed
POST /resources/kyt/txns/{txnId}/ownership/confirmed

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

operationId: Transaction_confirmOwnership

Parameters

Name In Required Type Description
txnId path required string

A unique transaction identifier.

Responses

200

OK
POST /resources/kyt/txns/{txnId}/ownership/confirmed
POST /resources/kyt/txns/{txnId}/ownership/unconfirmed

Removes the ownership from a previously confirmed transaction.

operationId: Transaction_removeOwnership

Parameters

Name In Required Type Description
txnId path required string

A unique transaction identifier.

Responses

200

OK
POST /resources/kyt/txns/{txnId}/ownership/unconfirmed

Verification 1 endpoints

POST /resources/applicants/{applicantId}/ekyc/submit (COPY)

Submits the applicant data for Non-Doc Verification.

operationId: Verification_submitApplicantData

Parameters

Name In Required Type Description
applicantId path required string

A unique applicant identifier.

Request Body

application/json
schema VerificationSubmitApplicantDataRequest
Property Type Required
info object optional
└ tin string optional
└ country string optional
└ firstName string optional
idDoc object optional
└ dob string optional
└ gender string optional
└ number string optional
└ country string optional
└ lastName string optional
└ firstName string optional
└ idDocType string optional
multipart/form-data
schema VerificationSubmitApplicantDataRequest1
Property Type Required
info object optional
└ tin string optional
└ country string optional
└ firstName string optional
idDoc object optional
└ dob string optional
└ gender string optional
└ number string optional
└ country string optional
└ lastName string optional
└ firstName string optional
└ idDocType string optional

Responses

200

OK
POST /resources/applicants/{applicantId}/ekyc/submit (COPY)
Load more endpoints

Schemas

object AccessTokenConfirmPlatformEventRequest 
{
  "type": "object",
  "required": [
    "applicant",
    "userPlatformEventInfo",
    "txnId"
  ],
  "properties": {
    "txnId": {
      "type": "string",
      "description": "Unique identifier for the confirmed applicant platform event that you generate on your side."
    },
    "applicant": {
      "type": "object",
      "required": [
        "fullName",
        "externalUserId"
      ],
      "properties": {
        "fullName": {
          "type": "string",
          "description": "Full name of the applicant."
        },
        "externalUserId": {
          "type": "string",
          "description": "A unique applicant identifier within your system."
        }
      },
      "description": "Applicant's full name and identifier on your side."
    },
    "userPlatformEventInfo": {
      "type": "object",
      "properties": {
        "failure": {
          "type": "boolean",
          "description": "Indicates whether the event on the applicant side was successful or not. <ul><li><code>true</code> — event failed (e.g. wrong credentials provided when logging in, or incorrect data submitted when resetting password).</li><li><code>false</code> — event was successful.</li></ul>"
        }
      },
      "description": "Indicates the applicant platform event status. Can be omitted if the event was successful."
    }
  }
}
object AccessTokenConfirmPlatformEventRequest1 
{
  "type": "object",
  "required": [
    "applicant",
    "userPlatformEventInfo",
    "txnId"
  ],
  "properties": {
    "txnId": {
      "type": "string",
      "description": "Unique identifier for the confirmed applicant platform event that you generate on your side."
    },
    "applicant": {
      "type": "object",
      "required": [
        "fullName",
        "externalUserId"
      ],
      "properties": {
        "fullName": {
          "type": "string",
          "description": "Full name of the applicant."
        },
        "externalUserId": {
          "type": "string",
          "description": "A unique applicant identifier within your system."
        }
      },
      "description": "Applicant's full name and identifier on your side."
    },
    "userPlatformEventInfo": {
      "type": "object",
      "properties": {
        "failure": {
          "type": "boolean",
          "description": "Indicates whether the event on the applicant side was successful or not. <ul><li><code>true</code> — event failed (e.g. wrong credentials provided when logging in, or incorrect data submitted when resetting password).</li><li><code>false</code> — event was successful.</li></ul>"
        }
      },
      "description": "Indicates the applicant platform event status. Can be omitted if the event was successful."
    }
  }
}
object AccessTokenGenerateFishermanTokenRequest 
{
  "type": "object",
  "required": [
    "sessionId",
    "userPlatformEventType"
  ],
  "properties": {
    "sessionId": {
      "type": "string",
      "description": "A unique identifier of the applicant session."
    },
    "ttlInSecs": {
      "type": "integer",
      "format": "int32",
      "default": 1800,
      "description": "A lifespan of a token in seconds. Default value is 1800 seconds."
    },
    "userPlatformEventType": {
      "type": "string",
      "description": "An event that occurred on the applicant device as a result of the interaction with the application UI. <br><br>The following event types are supported: <ul><li><code>login</code> — applicant logging in.</li><li><code>signup</code> — applicant signing up.</li><li><code>passwordReset</code> — applicant resetting the password.</li><li><code>twoFaReset</code> — applicant resetting two-factor authentication.</li></ul>"
    }
  }
}
object AccessTokenGenerateFishermanTokenRequest1 
{
  "type": "object",
  "required": [
    "sessionId",
    "userPlatformEventType"
  ],
  "properties": {
    "sessionId": {
      "type": "string",
      "description": "A unique identifier of the applicant session."
    },
    "ttlInSecs": {
      "type": "integer",
      "format": "int32",
      "default": 1800,
      "description": "A lifespan of a token in seconds. Default value is 1800 seconds."
    },
    "userPlatformEventType": {
      "type": "string",
      "description": "An event that occurred on the applicant device as a result of the interaction with the application UI. <br><br>The following event types are supported: <ul><li><code>login</code> — applicant logging in.</li><li><code>signup</code> — applicant signing up.</li><li><code>passwordReset</code> — applicant resetting the password.</li><li><code>twoFaReset</code> — applicant resetting two-factor authentication.</li></ul>"
    }
  }
}
object AnalysisStandaloneCryptoInitiationRequest 
{
  "type": "object",
  "required": [
    "currency",
    "direction",
    "address"
  ],
  "properties": {
    "txn": {
      "type": "string",
      "description": "Transaction hash. For `withdrawals`, `txn` should not be set at all or set to `null`."
    },
    "address": {
      "type": "string",
      "description": "Target address hash."
    },
    "tokenId": {
      "type": "string",
      "description": "Check the [Get available tokens](ref:get-available-tokens) method to get the full list of available currencies and token IDs."
    },
    "currency": {
      "type": "string",
      "description": "`BTC`, `ETH`, `BCH`, `LTC`, `USDT`, `ERC-20`, `BSV`, `XLM`, ..."
    },
    "direction": {
      "type": "string",
      "description": "An operation type. Can be `withdrawal` or `deposit`."
    }
  }
}
object AnalysisStandaloneCryptoInitiationRequest1 
{
  "type": "object",
  "required": [
    "currency",
    "direction",
    "address"
  ],
  "properties": {
    "txn": {
      "type": "string",
      "description": "Transaction hash. For `withdrawals`, `txn` should not be set at all or set to `null`."
    },
    "address": {
      "type": "string",
      "description": "Target address hash."
    },
    "tokenId": {
      "type": "string",
      "description": "Check the [Get available tokens](ref:get-available-tokens) method to get the full list of available currencies and token IDs."
    },
    "currency": {
      "type": "string",
      "description": "`BTC`, `ETH`, `BCH`, `LTC`, `USDT`, `ERC-20`, `BSV`, `XLM`, ..."
    },
    "direction": {
      "type": "string",
      "description": "An operation type. Can be `withdrawal` or `deposit`."
    }
  }
}
object ApplicantAddBeneficiaryRequest 
{
  "type": "object",
  "required": [
    "applicant",
    "applicantId",
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "ubo",
        "shareholder",
        "representative",
        "director"
      ],
      "type": "string",
      "description": "Beneficiary type."
    },
    "applicant": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "applicantId of beneficiary"
        }
      },
      "description": "An object that represents an individual applicant identifier."
    },
    "positions": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The list of positions in the company (`[\"director\", \"shareholder\", \"other\"]`)."
    },
    "applicantId": {
      "type": "string",
      "description": "Beneficiary applicant identifier."
    }
  }
}
object ApplicantAddBeneficiaryRequest1 
{
  "type": "object",
  "required": [
    "applicant",
    "applicantId",
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "ubo",
        "shareholder",
        "representative",
        "director"
      ],
      "type": "string",
      "description": "Beneficiary type."
    },
    "applicant": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "applicantId of beneficiary"
        }
      },
      "description": "An object that represents an individual applicant identifier."
    },
    "positions": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The list of positions in the company (`[\"director\", \"shareholder\", \"other\"]`)."
    },
    "applicantId": {
      "type": "string",
      "description": "Beneficiary applicant identifier."
    }
  }
}
object ApplicantAddConsentToProfileRequest 
{
  "type": "object",
  "required": [
    "records"
  ],
  "properties": {
    "records": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "content": {
            "type": "string",
            "description": "Full raw consent text."
          }
        }
      },
      "description": "An array of applicant consents."
    },
    "acceptedAt": {
      "type": "string",
      "description": "Date and time a consent was accepted by the applicant."
    },
    "residenceCountry": {
      "type": "string",
      "description": "An applicant country of residence in Alpha-3 format. For example, `USA` for the United States of America or `GBR` for Great Britain."
    }
  }
}
object ApplicantAddConsentToProfileRequest1 
{
  "type": "object",
  "required": [
    "records"
  ],
  "properties": {
    "records": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "content": {
            "type": "string",
            "description": "Full raw consent text."
          }
        }
      },
      "description": "An array of applicant consents."
    },
    "acceptedAt": {
      "type": "string",
      "description": "Date and time a consent was accepted by the applicant."
    },
    "residenceCountry": {
      "type": "string",
      "description": "An applicant country of residence in Alpha-3 format. For example, `USA` for the United States of America or `GBR` for Great Britain."
    }
  }
}
object ApplicantAddCustomTagsRequest 
{
  "type": "object",
  "properties": {
    "RAW_BODY": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
object ApplicantAddCustomTagsRequest1 
{
  "type": "object",
  "properties": {
    "RAW_BODY": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
object ApplicantAddCustomTagsRequest2 
{
  "type": "object",
  "properties": {
    "RAW_BODY": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
object ApplicantAddCustomTagsRequest3 
{
  "type": "object",
  "properties": {
    "RAW_BODY": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
object ApplicantAddIdDocumentRequest 
{
  "type": "object",
  "properties": {
    "content": {
      "type": "string",
      "format": "binary",
      "description": "A photo of the document."
    },
    "metadata": {
      "type": "object",
      "required": [
        "idDocType",
        "country"
      ],
      "properties": {
        "dob": {
          "type": "string",
          "description": "Applicant date of birth."
        },
        "number": {
          "type": "string",
          "description": "A document number."
        },
        "country": {
          "type": "string",
          "description": "ISO 3166-1 alpha-3 country code."
        },
        "lastName": {
          "type": "string",
          "description": "Last applicant name."
        },
        "firstName": {
          "type": "string",
          "description": "First applicant name."
        },
        "idDocType": {
          "type": "string",
          "description": "A document type."
        },
        "issuedDate": {
          "type": "string",
          "description": "Issued date (format `YYYY-mm-dd`, e.g. 2001-09-25)."
        },
        "middleName": {
          "type": "string",
          "description": "Middle applicant name."
        },
        "validUntil": {
          "type": "string",
          "description": "Valid until date (format `YYYY-mm-dd`, e.g. 2001-09-26)."
        },
        "idDocSubType": {
          "type": "string",
          "description": "`FRONT_SIDE`, `BACK_SIDE` or `null`."
        },
        "placeOfBirth": {
          "type": "string",
          "description": "Applicant birthplace."
        }
      },
      "description": "An object that represents an ID document."
    }
  }
}
object ApplicantAddIdDocumentRequest1 
{
  "type": "object",
  "properties": {
    "content": {
      "type": "string",
      "format": "binary",
      "description": "A photo of the document."
    },
    "metadata": {
      "type": "object",
      "required": [
        "idDocType",
        "country"
      ],
      "properties": {
        "dob": {
          "type": "string",
          "description": "Applicant date of birth."
        },
        "number": {
          "type": "string",
          "description": "A document number."
        },
        "country": {
          "type": "string",
          "description": "ISO 3166-1 alpha-3 country code."
        },
        "lastName": {
          "type": "string",
          "description": "Last applicant name."
        },
        "firstName": {
          "type": "string",
          "description": "First applicant name."
        },
        "idDocType": {
          "type": "string",
          "description": "A document type."
        },
        "issuedDate": {
          "type": "string",
          "description": "Issued date (format `YYYY-mm-dd`, e.g. 2001-09-25)."
        },
        "middleName": {
          "type": "string",
          "description": "Middle applicant name."
        },
        "validUntil": {
          "type": "string",
          "description": "Valid until date (format `YYYY-mm-dd`, e.g. 2001-09-26)."
        },
        "idDocSubType": {
          "type": "string",
          "description": "`FRONT_SIDE`, `BACK_SIDE` or `null`."
        },
        "placeOfBirth": {
          "type": "string",
          "description": "Applicant birthplace."
        }
      },
      "description": "An object that represents an ID document."
    }
  }
}
object ApplicantAddImageToPaymentMethodRequest 
{
  "type": "object",
  "required": [
    "content",
    "metadata"
  ],
  "properties": {
    "content": {
      "type": "string",
      "format": "binary",
      "description": "A document photo."
    },
    "metadata": {
      "type": "object",
      "required": [
        "idDocType",
        "country"
      ],
      "properties": {
        "country": {
          "type": "string"
        },
        "idDocType": {
          "type": "string"
        }
      },
      "description": "An object representing a payment method."
    }
  }
}
object ApplicantAddImageToPaymentMethodRequest1 
{
  "type": "object",
  "required": [
    "content",
    "metadata"
  ],
  "properties": {
    "content": {
      "type": "string",
      "format": "binary",
      "description": "A document photo."
    },
    "metadata": {
      "type": "object",
      "required": [
        "idDocType",
        "country"
      ],
      "properties": {
        "country": {
          "type": "string"
        },
        "idDocType": {
          "type": "string"
        }
      },
      "description": "An object representing a payment method."
    }
  }
}
object ApplicantAddPaymentMethodInformationRequest 
{
  "type": "object",
  "required": [
    "type"
  ],
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "requiredIdDoc": {
          "type": "object",
          "properties": {
            "number": {
              "type": "string"
            },
            "lastName": {
              "type": "string"
            },
            "firstName": {
              "type": "string"
            },
            "txnAmount": {
              "type": "string"
            },
            "issuedDate": {
              "type": "string"
            },
            "middleName": {
              "type": "string"
            }
          }
        }
      },
      "description": "An object that represents a payment method. `requiredIdDoc` contains information for comparison with the recognized image data from the applicant."
    },
    "type": {
      "type": "string",
      "description": "A payment type. Can be: `bankCard`, `eWallet`, `wireTransfer`."
    },
    "subType": {
      "type": "string",
      "description": "A payment subtype. For example, `VISA`, `MASTERCARD`, etc."
    }
  }
}
object ApplicantAddPaymentMethodInformationRequest1 
{
  "type": "object",
  "required": [
    "type"
  ],
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "requiredIdDoc": {
          "type": "object",
          "properties": {
            "number": {
              "type": "string"
            },
            "lastName": {
              "type": "string"
            },
            "firstName": {
              "type": "string"
            },
            "txnAmount": {
              "type": "string"
            },
            "issuedDate": {
              "type": "string"
            },
            "middleName": {
              "type": "string"
            }
          }
        }
      },
      "description": "An object that represents a payment method. `requiredIdDoc` contains information for comparison with the recognized image data from the applicant."
    },
    "type": {
      "type": "string",
      "description": "A payment type. Can be: `bankCard`, `eWallet`, `wireTransfer`."
    },
    "subType": {
      "type": "string",
      "description": "A payment subtype. For example, `VISA`, `MASTERCARD`, etc."
    }
  }
}
object ApplicantChangeCompanyDataRequest 
{
  "type": "object",
  "required": [
    "companyName",
    "registrationNumber"
  ],
  "properties": {
    "type": {
      "type": "string",
      "description": "Type of entity."
    },
    "email": {
      "type": "string",
      "description": "Email address."
    },
    "phone": {
      "type": "string",
      "description": "Phone number."
    },
    "taxId": {
      "type": "string",
      "description": "Taxpayer registration number/Code of taxpayer registration."
    },
    "country": {
      "type": "string",
      "description": "A three-letter country code (e.g. `DEU`)."
    },
    "website": {
      "type": "string",
      "description": "Website URL."
    },
    "addresses": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of addresses."
    },
    "companyName": {
      "type": "string",
      "description": "Company name."
    },
    "legalAddress": {
      "type": "string",
      "description": "Legal name."
    },
    "beneficiaries": {
      "type": "array",
      "items": {
        "description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
      },
      "description": "Applicant IDs of beneficiaries and additional info like position and type."
    },
    "controlScheme": {
      "type": "string",
      "description": "Description of the control scheme of the group of entities."
    },
    "postalAddress": {
      "type": "string",
      "description": "Postal address."
    },
    "incorporatedOn": {
      "type": "string",
      "description": "Date of incorporation (format `YYYY-mm-dd`, e.g. 2001-09-25)."
    },
    "registrationNumber": {
      "type": "string",
      "description": "Registration number."
    },
    "registrationLocation": {
      "type": "string",
      "description": "Location of registration."
    }
  }
}
object ApplicantChangeCompanyDataRequest1 
{
  "type": "object",
  "required": [
    "companyName",
    "registrationNumber"
  ],
  "properties": {
    "type": {
      "type": "string",
      "description": "Type of entity."
    },
    "email": {
      "type": "string",
      "description": "Email address."
    },
    "phone": {
      "type": "string",
      "description": "Phone number."
    },
    "taxId": {
      "type": "string",
      "description": "Taxpayer registration number/Code of taxpayer registration."
    },
    "country": {
      "type": "string",
      "description": "A three-letter country code (e.g. `DEU`)."
    },
    "website": {
      "type": "string",
      "description": "Website URL."
    },
    "addresses": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of addresses."
    },
    "companyName": {
      "type": "string",
      "description": "Company name."
    },
    "legalAddress": {
      "type": "string",
      "description": "Legal name."
    },
    "beneficiaries": {
      "type": "array",
      "items": {
        "description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
      },
      "description": "Applicant IDs of beneficiaries and additional info like position and type."
    },
    "controlScheme": {
      "type": "string",
      "description": "Description of the control scheme of the group of entities."
    },
    "postalAddress": {
      "type": "string",
      "description": "Postal address."
    },
    "incorporatedOn": {
      "type": "string",
      "description": "Date of incorporation (format `YYYY-mm-dd`, e.g. 2001-09-25)."
    },
    "registrationNumber": {
      "type": "string",
      "description": "Registration number."
    },
    "registrationLocation": {
      "type": "string",
      "description": "Location of registration."
    }
  }
}
object ApplicantChangeExtractedInfoRequest 
{
  "type": "object",
  "properties": {
    "dob": {
      "type": "string",
      "description": "Applicant date of birth (format `YYYY-mm-dd`, e.g. 2001-09-25)."
    },
    "tin": {
      "type": "string",
      "description": "Tax identification number."
    },
    "gender": {
      "type": "string",
      "description": "An applicant gender (`M` or `F`)."
    },
    "country": {
      "type": "string",
      "description": "Alpha-3 country code (e.g. `DEU` or `GBR`)."
    },
    "lastName": {
      "type": "string",
      "description": "The last name of the applicant."
    },
    "addresses": {
      "type": "string",
      "description": "List of applicant addresses."
    },
    "firstName": {
      "type": "string",
      "description": "The first name of the applicant."
    },
    "legalName": {
      "type": "string",
      "description": "Legal name."
    },
    "middleName": {
      "type": "string",
      "description": "The middle name of the applicant."
    },
    "nationality": {
      "type": "string",
      "description": "Alpha-3 country code."
    },
    "placeOfBirth": {
      "type": "string",
      "description": "The applicant birthplace."
    },
    "stateOfBirth": {
      "type": "string",
      "description": "Applicant state of birth."
    },
    "countryOfBirth": {
      "type": "string",
      "description": "Applicant country of birth."
    }
  }
}
object ApplicantChangeExtractedInfoRequest1 
{
  "type": "object",
  "properties": {
    "dob": {
      "type": "string",
      "description": "Applicant date of birth (format `YYYY-mm-dd`, e.g. 2001-09-25)."
    },
    "tin": {
      "type": "string",
      "description": "Tax identification number."
    },
    "gender": {
      "type": "string",
      "description": "An applicant gender (`M` or `F`)."
    },
    "country": {
      "type": "string",
      "description": "Alpha-3 country code (e.g. `DEU` or `GBR`)."
    },
    "lastName": {
      "type": "string",
      "description": "The last name of the applicant."
    },
    "addresses": {
      "type": "string",
      "description": "List of applicant addresses."
    },
    "firstName": {
      "type": "string",
      "description": "The first name of the applicant."
    },
    "legalName": {
      "type": "string",
      "description": "Legal name."
    },
    "middleName": {
      "type": "string",
      "description": "The middle name of the applicant."
    },
    "nationality": {
      "type": "string",
      "description": "Alpha-3 country code."
    },
    "placeOfBirth": {
      "type": "string",
      "description": "The applicant birthplace."
    },
    "stateOfBirth": {
      "type": "string",
      "description": "Applicant state of birth."
    },
    "countryOfBirth": {
      "type": "string",
      "description": "Applicant country of birth."
    }
  }
}
object ApplicantConfirmDataRequest 
{
  "type": "object",
  "properties": {
    "otp": {
      "type": "object",
      "required": [
        "code"
      ],
      "properties": {
        "code": {
          "type": "string",
          "description": "OTP that was sent to applicant."
        }
      },
      "description": "OTP confirmation data if `confirmationType` is `otp`."
    },
    "oauth": {
      "type": "object",
      "required": [
        "completeUrl"
      ],
      "properties": {
        "completeUrl": {
          "type": "string",
          "description": "Final redirected URL of the auth journey with query params. Format: `redirectUrl?<queryParams>`."
        }
      },
      "description": "oAuth confirmation data if `confirmationType` is `oAuth`."
    }
  }
}
object ApplicantConfirmDataRequest1 
{
  "type": "object",
  "properties": {
    "otp": {
      "type": "object",
      "required": [
        "code"
      ],
      "properties": {
        "code": {
          "type": "string",
          "description": "OTP that was sent to applicant."
        }
      },
      "description": "OTP confirmation data if `confirmationType` is `otp`."
    },
    "oauth": {
      "type": "object",
      "required": [
        "completeUrl"
      ],
      "properties": {
        "completeUrl": {
          "type": "string",
          "description": "Final redirected URL of the auth journey with query params. Format: `redirectUrl?<queryParams>`."
        }
      },
      "description": "oAuth confirmation data if `confirmationType` is `oAuth`."
    }
  }
}
object ApplicantCreateActionRequest 
{
  "type": "object",
  "required": [
    "externalActionId"
  ],
  "properties": {
    "email": {
      "type": "string",
      "description": "Applicant email address."
    },
    "phone": {
      "type": "string",
      "description": "Applicant phone number."
    },
    "paymentMethod": {
      "type": "object",
      "required": [
        "type"
      ],
      "properties": {
        "data": {
          "type": "object",
          "properties": {
            "requiredIdDoc": {
              "type": "object",
              "properties": {
                "number": {
                  "type": "string"
                },
                "lastName": {
                  "type": "string"
                },
                "firstName": {
                  "type": "string"
                },
                "txnAmount": {
                  "type": "string"
                },
                "issuedDate": {
                  "type": "string"
                },
                "middleName": {
                  "type": "string"
                }
              }
            }
          },
          "description": "An object that represents a payment method. `requiredIdDoc` contains information for comparison with the recognized image data from the applicant."
        },
        "type": {
          "type": "string",
          "description": "A payment type. Can be: `bankCard`, `eWallet`, `wireTransfer`."
        },
        "subType": {
          "type": "string",
          "description": "A payment subtype. For example, `VISA`, `MASTERCARD`, etc."
        }
      },
      "description": "Object that represents a specific payment method required from the applicant. You can send the data that will be shown to the user as a hint."
    },
    "externalActionId": {
      "type": "string",
      "description": "An external action ID which will be bound to the token."
    }
  }
}
object ApplicantCreateActionRequest1 
{
  "type": "object",
  "required": [
    "externalActionId"
  ],
  "properties": {
    "email": {
      "type": "string",
      "description": "Applicant email address."
    },
    "phone": {
      "type": "string",
      "description": "Applicant phone number."
    },
    "paymentMethod": {
      "type": "object",
      "required": [
        "type"
      ],
      "properties": {
        "data": {
          "type": "object",
          "properties": {
            "requiredIdDoc": {
              "type": "object",
              "properties": {
                "number": {
                  "type": "string"
                },
                "lastName": {
                  "type": "string"
                },
                "firstName": {
                  "type": "string"
                },
                "txnAmount": {
                  "type": "string"
                },
                "issuedDate": {
                  "type": "string"
                },
                "middleName": {
                  "type": "string"
                }
              }
            }
          },
          "description": "An object that represents a payment method. `requiredIdDoc` contains information for comparison with the recognized image data from the applicant."
        },
        "type": {
          "type": "string",
          "description": "A payment type. Can be: `bankCard`, `eWallet`, `wireTransfer`."
        },
        "subType": {
          "type": "string",
          "description": "A payment subtype. For example, `VISA`, `MASTERCARD`, etc."
        }
      },
      "description": "Object that represents a specific payment method required from the applicant. You can send the data that will be shown to the user as a hint."
    },
    "externalActionId": {
      "type": "string",
      "description": "An external action ID which will be bound to the token."
    }
  }
}
object ApplicantCreateCryptoSourceOfFundsRequest 
{
  "type": "object",
  "required": [
    "currency",
    "direction",
    "address"
  ],
  "properties": {
    "txn": {
      "type": "string",
      "description": "Transaction hash. For `withdrawals`, `txn` should not be set at all or set to `null`."
    },
    "address": {
      "type": "string",
      "description": "Target address hash."
    },
    "tokenId": {
      "type": "string",
      "description": "Check the [Get available tokens](ref:get-available-tokens) method to get the full list of available currencies and token IDs."
    },
    "currency": {
      "type": "string",
      "description": "`BTC`, `ETH`, `BCH`, `LTC`, `USDT`, `ERC-20`, `BSV`, `XLM`, ..."
    },
    "direction": {
      "type": "string",
      "description": "Operation type. Can be `withdrawal` or `deposit`."
    }
  }
}
object ApplicantCreateCryptoSourceOfFundsRequest1 
{
  "type": "object",
  "required": [
    "currency",
    "direction",
    "address"
  ],
  "properties": {
    "txn": {
      "type": "string",
      "description": "Transaction hash. For `withdrawals`, `txn` should not be set at all or set to `null`."
    },
    "address": {
      "type": "string",
      "description": "Target address hash."
    },
    "tokenId": {
      "type": "string",
      "description": "Check the [Get available tokens](ref:get-available-tokens) method to get the full list of available currencies and token IDs."
    },
    "currency": {
      "type": "string",
      "description": "`BTC`, `ETH`, `BCH`, `LTC`, `USDT`, `ERC-20`, `BSV`, `XLM`, ..."
    },
    "direction": {
      "type": "string",
      "description": "Operation type. Can be `withdrawal` or `deposit`."
    }
  }
}
object ApplicantCreatePaymentSourceActionsRequest 
{
  "type": "object",
  "properties": {
    "paymentSource": {
      "type": "object",
      "properties": {
        "fixedInfo": {
          "type": "object",
          "properties": {
            "type": {
              "enum": [
                "bankCard",
                "bankStatement",
                "eWallet",
                "cryptoWallet"
              ],
              "type": "string",
              "description": "A payment source type."
            },
            "email": {
              "type": "string",
              "description": "An email address associated with a particular account."
            },
            "fullName": {
              "type": "string",
              "description": "The full name of an account holder (e.g., \"Alex Kim\")."
            },
            "institutionName": {
              "type": "string",
              "description": "A name of the financial institution where an account is held (e.g., Revolut)."
            },
            "accountIdentifier": {
              "type": "string",
              "description": "A unique identifier for an account (e.g., \"123456\")."
            }
          },
          "description": "Additional fixed information related to a payment source."
        }
      },
      "description": "Data on a payment source."
    },
    "externalActionId": {
      "type": "string",
      "description": "An external identifier for an action."
    }
  }
}
object ApplicantCreatePaymentSourceActionsRequest1 
{
  "type": "object",
  "properties": {
    "paymentSource": {
      "type": "object",
      "properties": {
        "fixedInfo": {
          "type": "object",
          "properties": {
            "type": {
              "enum": [
                "bankCard",
                "bankStatement",
                "eWallet",
                "cryptoWallet"
              ],
              "type": "string",
              "description": "A payment source type."
            },
            "email": {
              "type": "string",
              "description": "An email address associated with a particular account."
            },
            "fullName": {
              "type": "string",
              "description": "The full name of an account holder (e.g., \"Alex Kim\")."
            },
            "institutionName": {
              "type": "string",
              "description": "A name of the financial institution where an account is held (e.g., Revolut)."
            },
            "accountIdentifier": {
              "type": "string",
              "description": "A unique identifier for an account (e.g., \"123456\")."
            }
          },
          "description": "Additional fixed information related to a payment source."
        }
      },
      "description": "Data on a payment source."
    },
    "externalActionId": {
      "type": "string",
      "description": "An external identifier for an action."
    }
  }
}
object ApplicantCreatePaymentSourceActionsResponse 
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "65e9624496bed30142a6d15c"
    },
    "key": {
      "type": "string",
      "example": "SBCJVLAAMRHYAB"
    },
    "review": {
      "type": "object",
      "properties": {
        "reviewId": {
          "type": "string",
          "example": "RlWfu"
        },
        "attemptId": {
          "type": "string",
          "example": "dhABq"
        },
        "levelName": {
          "type": "string",
          "example": "paymentSource"
        },
        "attemptCnt": {
          "type": "integer",
          "default": 0,
          "example": 0
        },
        "createDate": {
          "type": "string",
          "example": "2024-03-07T06:44:24.000+00:00"
        },
        "reviewStatus": {
          "type": "string",
          "example": "init"
        }
      }
    },
    "clientId": {
      "type": "string",
      "example": "client_id"
    },
    "createdAt": {
      "type": "string",
      "example": "2024-03-07 06:44:24"
    },
    "applicantId": {
      "type": "string",
      "example": "65e881a212b4ef468def3bbb"
    },
    "paymentSource": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "c4032de1-2e1c-4b29-8a81-623103f9cd51"
        },
        "createdAt": {
          "type": "string",
          "example": "2024-03-07 06:44:24"
        },
        "fixedInfo": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "example": "paymentMethod"
            },
            "email": {
              "type": "string",
              "example": "JohnDoe@mail.com"
            },
            "fullName": {
              "type": "string",
              "example": "John Doe"
            },
            "institutionName": {
              "type": "string",
              "example": "Name"
            },
            "accountIdentifier": {
              "type": "string",
              "example": "120834387"
            }
          }
        }
      }
    },
    "requiredIdDocs": {
      "type": "object",
      "properties": {
        "docSets": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "types": {
                "type": "array",
                "items": {
                  "type": "string",
                  "example": "PAYMENT_SOURCE"
                }
              },
              "idDocSetType": {
                "type": "string",
                "example": "PAYMENT_METHODS"
              }
            }
          }
        }
      }
    },
    "externalActionId": {
      "type": "string",
      "example": "payment-source-1fbH9AYHn"
    }
  }
}
object ApplicantEnrichTransactionWithTravelRuleDataRequest 
{
  "type": "object",
  "required": [
    "fullName"
  ],
  "properties": {
    "fullName": {
      "type": "string",
      "description": "Participant full name."
    }
  }
}
object ApplicantEnrichTransactionWithTravelRuleDataRequest1 
{
  "type": "object",
  "required": [
    "fullName"
  ],
  "properties": {
    "fullName": {
      "type": "string",
      "description": "Participant full name."
    }
  }
}
object ApplicantEnrichTransactionWithTravelRuleDataResponse 
{
  "type": "object",
  "properties": {}
}
object ApplicantGetDataByExternalUserIdResponse 
{
  "oneOf": [
    {
      "type": "object",
      "title": "Individual applicants",
      "properties": {
        "id": {
          "type": "string",
          "example": "5b594ade0a975a36c9349e66"
        },
        "info": {
          "type": "object",
          "properties": {
            "dob": {
              "type": "string",
              "example": "1989-07-16"
            },
            "idDocs": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "dob": {
                    "type": "string",
                    "example": "1989-07-16"
                  },
                  "number": {
                    "type": "string",
                    "example": "LGXX359T8"
                  },
                  "country": {
                    "type": "string",
                    "example": "DEU"
                  },
                  "lastName": {
                    "type": "string",
                    "example": "SMITH"
                  },
                  "mrzLine1": {
                    "type": "string",
                    "example": "IDD<<LGXX359T88<<<<<<<<<<<<<<<"
                  },
                  "mrzLine2": {
                    "type": "string",
                    "example": "8907167<2809045D<<<<<<<<<<<<<8"
                  },
                  "mrzLine3": {
                    "type": "string",
                    "example": "SMITH<<CHRISTIAN<<<<<<<<<<<<<<"
                  },
                  "firstName": {
                    "type": "string",
                    "example": "CHRISTIAN"
                  },
                  "idDocType": {
                    "type": "string",
                    "example": "ID_CARD"
                  },
                  "lastNameEn": {
                    "type": "string",
                    "example": "SMITH"
                  },
                  "validUntil": {
                    "type": "string",
                    "example": "2028-09-04"
                  },
                  "firstNameEn": {
                    "type": "string",
                    "example": "CHRISTIAN"
                  }
                }
              }
            },
            "country": {
              "type": "string",
              "example": "DEU"
            },
            "lastName": {
              "type": "string",
              "example": "SMITH"
            },
            "firstName": {
              "type": "string",
              "example": "CHRISTIAN"
            },
            "lastNameEn": {
              "type": "string",
              "example": "SMITH"
            },
            "firstNameEn": {
              "type": "string",
              "example": "CHRISTIAN"
            }
          }
        },
        "lang": {
          "type": "string",
          "example": "de"
        },
        "type": {
          "type": "string",
          "example": "individual"
        },
        "email": {
          "type": "string",
          "example": "christman1@gmail.com"
        },
        "review": {
          "type": "object",
          "properties": {
            "levelName": {
              "type": "string",
              "example": "basic-kyc"
            },
            "createDate": {
              "type": "string",
              "example": "2020-06-24T05:11:02.000+00:00"
            },
            "reviewDate": {
              "type": "string",
              "example": "2020-06-24T05:12:58.000+00:00"
            },
            "reprocessing": {
              "type": "boolean",
              "default": true,
              "example": true
            },
            "reviewResult": {
              "type": "object",
              "properties": {
                "reviewAnswer": {
                  "type": "string",
                  "example": "GREEN"
                }
              }
            },
            "reviewStatus": {
              "type": "string",
              "example": "completed"
            },
            "elapsedSinceQueuedMs": {
              "type": "integer",
              "default": 0,
              "example": 95785
            },
            "elapsedSincePendingMs": {
              "type": "integer",
              "default": 0,
              "example": 115879
            }
          }
        },
        "clientId": {
          "type": "string",
          "example": "ClientName"
        },
        "agreement": {
          "type": "object",
          "properties": {
            "source": {
              "type": "string",
              "example": "WebSDK"
            },
            "targets": {
              "type": "array",
              "items": {
                "type": "string",
                "example": "By clicking Next, I accept [the Terms and Conditions](https://www.sumsub.com/consent-to-personal-data-processing/)"
              }
            },
            "createdAt": {
              "type": "string",
              "example": "2020-06-24 04:18:40"
            }
          }
        },
        "createdAt": {
          "type": "string",
          "example": "2020-06-24 05:05:14"
        },
        "fixedInfo": {
          "type": "object",
          "properties": {
            "lastName": {
              "type": "string",
              "example": "Smith"
            },
            "firstName": {
              "type": "string",
              "example": "Chris"
            }
          }
        },
        "inspectionId": {
          "type": "string",
          "example": "5b594ade0a975a36c9379e67"
        },
        "externalUserId": {
          "type": "string",
          "example": "SomeExternalUserId"
        },
        "requiredIdDocs": {
          "type": "object",
          "properties": {
            "docSets": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "types": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "example": "PASSPORT"
                    }
                  },
                  "idDocSetType": {
                    "type": "string",
                    "example": "IDENTITY"
                  }
                }
              }
            }
          }
        },
        "applicantPlatform": {
          "type": "string",
          "example": "Android"
        }
      }
    },
    {
      "type": "object",
      "title": "Company applicants",
      "properties": {
        "id": {
          "type": "string",
          "example": "5ecfbe9ad5ea48743f8dd1b8"
        },
        "info": {
          "type": "object",
          "properties": {
            "companyInfo": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "example": "ltd"
                },
                "country": {
                  "type": "string",
                  "example": "GBR"
                },
                "website": {
                  "type": "string",
                  "example": "www.sumsub.com"
                },
                "companyName": {
                  "type": "string",
                  "example": "SUMSUB LIMITED"
                },
                "beneficiaries": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "type": {
                        "type": "string",
                        "example": "ubo"
                      },
                      "imageIds": {},
                      "applicant": {},
                      "positions": {
                        "type": "array",
                        "items": {
                          "type": "string",
                          "example": "director"
                        }
                      },
                      "inRegistry": {
                        "type": "boolean",
                        "default": true,
                        "example": false
                      },
                      "applicantId": {
                        "type": "string",
                        "example": "5ecfbecad5ea48743f8dd438"
                      }
                    }
                  }
                },
                "incorporatedOn": {
                  "type": "string",
                  "example": "2018-02-28 00:00:00"
                },
                "registrationNumber": {
                  "type": "string",
                  "example": "1555555"
                }
              }
            }
          }
        },
        "lang": {
          "type": "string",
          "example": "en"
        },
        "type": {
          "type": "string",
          "example": "company"
        },
        "review": {
          "type": "object",
          "properties": {
            "startDate": {
              "type": "string",
              "example": "2020-05-29T12:26:52.000+00:00"
            },
            "createDate": {
              "type": "string",
              "example": "2020-05-29T12:22:11.000+00:00"
            },
            "reviewDate": {
              "type": "string",
              "example": "2020-05-29T12:27:19.000+00:00"
            },
            "reprocessing": {
              "type": "boolean",
              "default": true,
              "example": true
            },
            "reviewResult": {
              "type": "object",
              "properties": {
                "reviewAnswer": {
                  "type": "string",
                  "example": "GREEN"
                }
              }
            },
            "reviewStatus": {
              "type": "string",
              "example": "completed"
            },
            "elapsedSinceQueuedMs": {
              "type": "integer",
              "default": 0,
              "example": 26993
            },
            "elapsedSincePendingMs": {
              "type": "integer",
              "default": 0,
              "example": 308656
            }
          }
        },
        "clientId": {
          "type": "string",
          "example": "coolclientid"
        },
        "createdAt": {
          "type": "string",
          "example": "2020-05-28 13:37:30"
        },
        "inspectionId": {
          "type": "string",
          "example": "5ecfbe9ad5ea48743f8dd1b9"
        },
        "externalUserId": {
          "type": "string",
          "example": "externalCompanyId"
        },
        "requiredIdDocs": {
          "type": "object",
          "properties": {
            "docSets": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "steps": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "name": {
                          "type": "string",
                          "example": "company"
                        },
                        "idDocTypes": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "COMPANY_DOC"
                          }
                        },
                        "minDocsCnt": {
                          "type": "integer",
                          "default": 0,
                          "example": 1
                        },
                        "idDocSubTypes": {}
                      }
                    }
                  },
                  "types": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "example": "COMPANY_DOC"
                    }
                  },
                  "idDocSetType": {
                    "type": "string",
                    "example": "COMPANY"
                  }
                }
              }
            }
          }
        }
      }
    }
  ]
}
object ApplicantGetDataResponse 
{
  "oneOf": [
    {
      "type": "object",
      "title": "Individual applicants",
      "properties": {
        "id": {
          "type": "string",
          "example": "5b594ade0a975a36c9349e66"
        },
        "info": {
          "type": "object",
          "properties": {
            "dob": {
              "type": "string",
              "example": "1989-07-16"
            },
            "idDocs": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "dob": {
                    "type": "string",
                    "example": "1989-07-16"
                  },
                  "number": {
                    "type": "string",
                    "example": "LGXX359T8"
                  },
                  "country": {
                    "type": "string",
                    "example": "DEU"
                  },
                  "lastName": {
                    "type": "string",
                    "example": "SMITH"
                  },
                  "mrzLine1": {
                    "type": "string",
                    "example": "IDD<<LGXX359T88<<<<<<<<<<<<<<<"
                  },
                  "mrzLine2": {
                    "type": "string",
                    "example": "8907167<2809045D<<<<<<<<<<<<<8"
                  },
                  "mrzLine3": {
                    "type": "string",
                    "example": "SMITH<<CHRISTIAN<<<<<<<<<<<<<<"
                  },
                  "firstName": {
                    "type": "string",
                    "example": "CHRISTIAN"
                  },
                  "idDocType": {
                    "type": "string",
                    "example": "ID_CARD"
                  },
                  "lastNameEn": {
                    "type": "string",
                    "example": "SMITH"
                  },
                  "validUntil": {
                    "type": "string",
                    "example": "2028-09-04"
                  },
                  "firstNameEn": {
                    "type": "string",
                    "example": "CHRISTIAN"
                  }
                }
              }
            },
            "country": {
              "type": "string",
              "example": "DEU"
            },
            "lastName": {
              "type": "string",
              "example": "SMITH"
            },
            "firstName": {
              "type": "string",
              "example": "CHRISTIAN"
            },
            "lastNameEn": {
              "type": "string",
              "example": "SMITH"
            },
            "firstNameEn": {
              "type": "string",
              "example": "CHRISTIAN"
            }
          }
        },
        "lang": {
          "type": "string",
          "example": "de"
        },
        "type": {
          "type": "string",
          "example": "individual"
        },
        "email": {
          "type": "string",
          "example": "christman1@gmail.com"
        },
        "review": {
          "type": "object",
          "properties": {
            "levelName": {
              "type": "string",
              "example": "basic-kyc"
            },
            "createDate": {
              "type": "string",
              "example": "2020-06-24T05:11:02.000+00:00"
            },
            "reviewDate": {
              "type": "string",
              "example": "2020-06-24T05:12:58.000+00:00"
            },
            "reprocessing": {
              "type": "boolean",
              "default": true,
              "example": true
            },
            "reviewResult": {
              "type": "object",
              "properties": {
                "reviewAnswer": {
                  "type": "string",
                  "example": "GREEN"
                }
              }
            },
            "reviewStatus": {
              "type": "string",
              "example": "completed"
            },
            "elapsedSinceQueuedMs": {
              "type": "integer",
              "default": 0,
              "example": 95785
            },
            "elapsedSincePendingMs": {
              "type": "integer",
              "default": 0,
              "example": 115879
            }
          }
        },
        "clientId": {
          "type": "string",
          "example": "ClientName"
        },
        "agreement": {
          "type": "object",
          "properties": {
            "source": {
              "type": "string",
              "example": "WebSDK"
            },
            "targets": {
              "type": "array",
              "items": {
                "type": "string",
                "example": "By clicking Next, I accept [the Terms and Conditions](https://www.sumsub.com/consent-to-personal-data-processing/)"
              }
            },
            "createdAt": {
              "type": "string",
              "example": "2020-06-24 04:18:40"
            }
          }
        },
        "createdAt": {
          "type": "string",
          "example": "2020-06-24 05:05:14"
        },
        "fixedInfo": {
          "type": "object",
          "properties": {
            "lastName": {
              "type": "string",
              "example": "Smith"
            },
            "firstName": {
              "type": "string",
              "example": "Chris"
            }
          }
        },
        "inspectionId": {
          "type": "string",
          "example": "5b594ade0a975a36c9379e67"
        },
        "externalUserId": {
          "type": "string",
          "example": "SomeExternalUserId"
        },
        "requiredIdDocs": {
          "type": "object",
          "properties": {
            "docSets": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "types": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "example": "PASSPORT"
                    }
                  },
                  "idDocSetType": {
                    "type": "string",
                    "example": "IDENTITY"
                  }
                }
              }
            }
          }
        },
        "applicantPlatform": {
          "type": "string",
          "example": "Android"
        }
      }
    },
    {
      "type": "object",
      "title": "Company applicants",
      "properties": {
        "id": {
          "type": "string",
          "example": "5ecfbe9ad5ea48743f8dd1b8"
        },
        "info": {
          "type": "object",
          "properties": {
            "companyInfo": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "example": "ltd"
                },
                "country": {
                  "type": "string",
                  "example": "GBR"
                },
                "website": {
                  "type": "string",
                  "example": "www.sumsub.com"
                },
                "companyName": {
                  "type": "string",
                  "example": "SUMSUB LIMITED"
                },
                "beneficiaries": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "type": {
                        "type": "string",
                        "example": "ubo"
                      },
                      "imageIds": {},
                      "applicant": {},
                      "positions": {
                        "type": "array",
                        "items": {
                          "type": "string",
                          "example": "director"
                        }
                      },
                      "inRegistry": {
                        "type": "boolean",
                        "default": true,
                        "example": false
                      },
                      "applicantId": {
                        "type": "string",
                        "example": "5ecfbecad5ea48743f8dd438"
                      }
                    }
                  }
                },
                "incorporatedOn": {
                  "type": "string",
                  "example": "2018-02-28 00:00:00"
                },
                "registrationNumber": {
                  "type": "string",
                  "example": "1555555"
                }
              }
            }
          }
        },
        "lang": {
          "type": "string",
          "example": "en"
        },
        "type": {
          "type": "string",
          "example": "company"
        },
        "review": {
          "type": "object",
          "properties": {
            "startDate": {
              "type": "string",
              "example": "2020-05-29T12:26:52.000+00:00"
            },
            "createDate": {
              "type": "string",
              "example": "2020-05-29T12:22:11.000+00:00"
            },
            "reviewDate": {
              "type": "string",
              "example": "2020-05-29T12:27:19.000+00:00"
            },
            "reprocessing": {
              "type": "boolean",
              "default": true,
              "example": true
            },
            "reviewResult": {
              "type": "object",
              "properties": {
                "reviewAnswer": {
                  "type": "string",
                  "example": "GREEN"
                }
              }
            },
            "reviewStatus": {
              "type": "string",
              "example": "completed"
            },
            "elapsedSinceQueuedMs": {
              "type": "integer",
              "default": 0,
              "example": 26993
            },
            "elapsedSincePendingMs": {
              "type": "integer",
              "default": 0,
              "example": 308656
            }
          }
        },
        "clientId": {
          "type": "string",
          "example": "coolclientid"
        },
        "createdAt": {
          "type": "string",
          "example": "2020-05-28 13:37:30"
        },
        "inspectionId": {
          "type": "string",
          "example": "5ecfbe9ad5ea48743f8dd1b9"
        },
        "externalUserId": {
          "type": "string",
          "example": "externalCompanyId"
        },
        "requiredIdDocs": {
          "type": "object",
          "properties": {
            "docSets": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "steps": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "name": {
                          "type": "string",
                          "example": "company"
                        },
                        "idDocTypes": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "COMPANY_DOC"
                          }
                        },
                        "minDocsCnt": {
                          "type": "integer",
                          "default": 0,
                          "example": 1
                        },
                        "idDocSubTypes": {}
                      }
                    }
                  },
                  "types": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "example": "COMPANY_DOC"
                    }
                  },
                  "idDocSetType": {
                    "type": "string",
                    "example": "COMPANY"
                  }
                }
              }
            }
          }
        }
      }
    }
  ]
}
object ApplicantImportByArchiveRequest 
{
  "type": "object",
  "properties": {
    "content": {
      "type": "string",
      "format": "binary",
      "description": "An archive file."
    }
  }
}
object ApplicantImportByArchiveRequest1 
{
  "type": "object",
  "properties": {
    "content": {
      "type": "string",
      "format": "binary",
      "description": "An archive file."
    }
  }
}
object ApplicantImportCompletedRequest 
{
  "type": "object",
  "properties": {
    "info": {
      "type": "object",
      "properties": {
        "dob": {
          "type": "string",
          "description": "Applicant date of birth (format `YYYY-mm-dd`, e.g. 2001-09-25)."
        },
        "tin": {
          "type": "string",
          "description": "Tax identification number."
        },
        "gender": {
          "type": "string",
          "description": "An applicant gender (`M` or `F`)."
        },
        "country": {
          "type": "string",
          "description": "Alpha-3 country code (e.g. `DEU` or `GBR`)."
        },
        "lastName": {
          "type": "string",
          "description": "The last name of the applicant."
        },
        "addresses": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "town": {
                "type": "string",
                "description": "Town or city name."
              },
              "state": {
                "type": "string",
                "description": "State name (if applicable)."
              },
              "street": {
                "type": "string",
                "description": "Street name."
              },
              "country": {
                "type": "string",
                "description": "Alpha-3 country code."
              },
              "postCode": {
                "type": "string",
                "description": "Postal code."
              },
              "subStreet": {
                "type": "string",
                "description": "Additional street information."
              },
              "flatNumber": {
                "type": "string",
                "description": "Flat or apartment number."
              },
              "buildingName": {
                "type": "string",
                "description": "Building name (if applicable)."
              },
              "buildingNumber": {
                "type": "string",
                "description": "Building number."
              }
            }
          },
          "description": "List of applicant addresses."
        },
        "firstName": {
          "type": "string",
          "description": "The first name of the applicant."
        },
        "legalName": {
          "type": "string",
          "description": "Legal name."
        },
        "lastNameEn": {
          "type": "string",
          "description": "Automatic transliteration of the last name."
        },
        "middleName": {
          "type": "string",
          "description": "The middle name of the applicant."
        },
        "firstNameEn": {
          "type": "string",
          "description": "Automatic transliteration of the first name."
        },
        "nationality": {
          "type": "string",
          "description": "Alpha-3 country code."
        },
        "middleNameEn": {
          "type": "string",
          "description": "Automatic transliteration of the middle name."
        },
        "placeOfBirth": {
          "type": "string",
          "description": "The applicant birthplace."
        },
        "stateOfBirth": {
          "type": "string",
          "description": "Applicant state of birth."
        },
        "countryOfBirth": {
          "type": "string",
          "description": "Applicant country of birth."
        }
      },
      "description": "Holds the personal applicant information extracted during verification."
    },
    "review": {
      "type": "object",
      "properties": {
        "review": {
          "type": "object",
          "properties": {
            "reviewAnswer": {
              "type": "string",
              "description": "\"GREEN\"/\"RED\""
            },
            "clientComment": {
              "type": "string",
              "description": "internal reason of rejection"
            },
            "reviewRejectType": {
              "type": "string",
              "description": "\"FINAL\"/\"RETRY\"(used only when \"reviewAnswer\"=\"RED\")"
            },
            "moderationComment": {
              "type": "string",
              "description": "Reason of rejection for end-user"
            }
          }
        },
        "createDate": {
          "type": "string",
          "description": "Date of users' creation on your side in a format: \"2022-11-21 08:25:32+0000\""
        },
        "reviewDate": {
          "type": "string",
          "description": "review date on your side in a format: \"2022-11-21 08:25:32+0000\""
        },
        "reviewStatus": {
          "type": "string",
          "description": "\"completed\""
        }
      },
      "description": "Review results."
    },
    "externalUserId": {
      "type": "string",
      "description": "A unique applicant identifier as registered on your side."
    }
  }
}
object ApplicantImportCompletedRequest1 
{
  "type": "object",
  "properties": {
    "info": {
      "type": "object",
      "properties": {
        "dob": {
          "type": "string",
          "description": "Applicant date of birth (format `YYYY-mm-dd`, e.g. 2001-09-25)."
        },
        "tin": {
          "type": "string",
          "description": "Tax identification number."
        },
        "gender": {
          "type": "string",
          "description": "An applicant gender (`M` or `F`)."
        },
        "country": {
          "type": "string",
          "description": "Alpha-3 country code (e.g. `DEU` or `GBR`)."
        },
        "lastName": {
          "type": "string",
          "description": "The last name of the applicant."
        },
        "addresses": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "town": {
                "type": "string",
                "description": "Town or city name."
              },
              "state": {
                "type": "string",
                "description": "State name (if applicable)."
              },
              "street": {
                "type": "string",
                "description": "Street name."
              },
              "country": {
                "type": "string",
                "description": "Alpha-3 country code."
              },
              "postCode": {
                "type": "string",
                "description": "Postal code."
              },
              "subStreet": {
                "type": "string",
                "description": "Additional street information."
              },
              "flatNumber": {
                "type": "string",
                "description": "Flat or apartment number."
              },
              "buildingName": {
                "type": "string",
                "description": "Building name (if applicable)."
              },
              "buildingNumber": {
                "type": "string",
                "description": "Building number."
              }
            }
          },
          "description": "List of applicant addresses."
        },
        "firstName": {
          "type": "string",
          "description": "The first name of the applicant."
        },
        "legalName": {
          "type": "string",
          "description": "Legal name."
        },
        "lastNameEn": {
          "type": "string",
          "description": "Automatic transliteration of the last name."
        },
        "middleName": {
          "type": "string",
          "description": "The middle name of the applicant."
        },
        "firstNameEn": {
          "type": "string",
          "description": "Automatic transliteration of the first name."
        },
        "nationality": {
          "type": "string",
          "description": "Alpha-3 country code."
        },
        "middleNameEn": {
          "type": "string",
          "description": "Automatic transliteration of the middle name."
        },
        "placeOfBirth": {
          "type": "string",
          "description": "The applicant birthplace."
        },
        "stateOfBirth": {
          "type": "string",
          "description": "Applicant state of birth."
        },
        "countryOfBirth": {
          "type": "string",
          "description": "Applicant country of birth."
        }
      },
      "description": "Holds the personal applicant information extracted during verification."
    },
    "review": {
      "type": "object",
      "properties": {
        "review": {
          "type": "object",
          "properties": {
            "reviewAnswer": {
              "type": "string",
              "description": "\"GREEN\"/\"RED\""
            },
            "clientComment": {
              "type": "string",
              "description": "internal reason of rejection"
            },
            "reviewRejectType": {
              "type": "string",
              "description": "\"FINAL\"/\"RETRY\"(used only when \"reviewAnswer\"=\"RED\")"
            },
            "moderationComment": {
              "type": "string",
              "description": "Reason of rejection for end-user"
            }
          }
        },
        "createDate": {
          "type": "string",
          "description": "Date of users' creation on your side in a format: \"2022-11-21 08:25:32+0000\""
        },
        "reviewDate": {
          "type": "string",
          "description": "review date on your side in a format: \"2022-11-21 08:25:32+0000\""
        },
        "reviewStatus": {
          "type": "string",
          "description": "\"completed\""
        }
      },
      "description": "Review results."
    },
    "externalUserId": {
      "type": "string",
      "description": "A unique applicant identifier as registered on your side."
    }
  }
}
object ApplicantMoveTransactionToAnotherApplicantResponse 
{
  "type": "object",
  "properties": {}
}
object ApplicantRemoveCustomTagsRequest 
{
  "type": "object",
  "properties": {
    "RAW_BODY": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
object ApplicantRemoveCustomTagsRequest1 
{
  "type": "object",
  "properties": {
    "RAW_BODY": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
object ApplicantSandboxVerificationResponseRequest 
{
  "type": "object",
  "required": [
    "reviewAnswer",
    "rejectLabels"
  ],
  "properties": {
    "rejectLabels": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of [rejection labels](/docs/receive-and-interpret-results-via-api#understand-rejection)."
    },
    "reviewAnswer": {
      "type": "string",
      "description": "A `GREEN` or `RED` label under which you want to simulate the response. For more information, see [this article](https://docs.sumsub.com/reference)."
    },
    "clientComment": {
      "type": "string",
      "description": "A rejection comment that should not be available to your applicants."
    },
    "reviewRejectType": {
      "type": "string",
      "description": "A `FINAL` or `RETRY` rejection type indicating whether a rejection should be final or temporary."
    },
    "moderationComment": {
      "type": "string",
      "description": "A comment that supposed to be shown to the applicant, explaining the reason of rejection."
    }
  }
}
object ApplicantSandboxVerificationResponseRequest1 
{
  "type": "object",
  "required": [
    "reviewAnswer",
    "rejectLabels"
  ],
  "properties": {
    "rejectLabels": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of [rejection labels](/docs/receive-and-interpret-results-via-api#understand-rejection)."
    },
    "reviewAnswer": {
      "type": "string",
      "description": "A `GREEN` or `RED` label under which you want to simulate the response. For more information, see [this article](https://docs.sumsub.com/reference)."
    },
    "clientComment": {
      "type": "string",
      "description": "A rejection comment that should not be available to your applicants."
    },
    "reviewRejectType": {
      "type": "string",
      "description": "A `FINAL` or `RETRY` rejection type indicating whether a rejection should be final or temporary."
    },
    "moderationComment": {
      "type": "string",
      "description": "A comment that supposed to be shown to the applicant, explaining the reason of rejection."
    }
  }
}
object ApplicantSubmitTransactionDataRequest 
{
  "type": "object",
  "required": [
    "txnId",
    "info",
    "applicant",
    "counterparty"
  ],
  "properties": {
    "info": {
      "type": "object",
      "required": [
        "direction",
        "amount",
        "currencyCode"
      ],
      "properties": {
        "type": {
          "type": "string",
          "description": "Accepts any value that helps you categorize transactions. For example, for gambling transactions, you can specify `bonus`, `payroll`, or `cashback`."
        },
        "amount": {
          "type": "number",
          "format": "double",
          "description": "The amount of funds used in this transaction."
        },
        "direction": {
          "type": "string",
          "description": "Can be `out` (applicant sends to counterparty) or `in` (counterparty sends to applicant)."
        },
        "cryptoParams": {
          "type": "object",
          "required": [
            "attemptId"
          ],
          "properties": {
            "attemptId": {
              "type": "string",
              "description": "Unique identifier of the transaction attempt."
            },
            "cryptoChain": {
              "type": "string",
              "description": "The crypto chain name. Mandatory for crypto tokens only. Specifies the network name to which the token at `currencyCode` belongs. Empty for native tokens (e.g. for `BTC`, `ETH`). For more information, see [chain codes](ref:crypto-chain-codes)."
            },
            "outputIndex": {
              "type": "integer",
              "format": "int32",
              "description": "An index number for a transaction output."
            }
          },
          "description": "Includes crypto transaction parameters. It is crucial for Sumsub to understand which crypto chain is used to correctly utilize the data."
        },
        "currencyCode": {
          "type": "string",
          "description": "Currency code (`USD`, `GBP`, `BTC`, etc)."
        },
        "currencyType": {
          "type": "string",
          "description": "Indicates whether the transaction is `crypto` or `fiat`."
        },
        "paymentTxnId": {
          "type": "string",
          "description": "Crypto transaction ID from the blockchain. Required for crypto check requests only."
        },
        "paymentDetails": {
          "type": "string",
          "description": "A comment with payment details."
        },
        "amountInDefaultCurrency": {
          "type": "number",
          "format": "double",
          "description": "The amount of funds used in this transaction in the default currency. For more precise calculations, you can submit already converted default currency amount in this field."
        }
      },
      "description": "An object representing transaction information."
    },
    "type": {
      "type": "string",
      "default": "finance",
      "description": "A transaction type. Expects values: </br> <ul>   <li><code>finance</code>(default)</li>   <li><code>gamblingBet</code></li>   <li><code>gamblingLimitChange</code></li>   <li><code>gamblingBonusChange</code></li>   <li><code>kyc</code></li>   <li><code>travelRule</code></li>   <li><code>userPlatformEvent</code></li>   <ul>     <li><code>login</code></li>     <li><code>signup</code></li>     <li><code>passwordChange</code></li>     <li><code>twoFaReset</code></li>   </ul> </ul>"
    },
    "props": {
      "type": "object",
      "properties": {
        "customTxnLimit": {
          "type": "string",
          "default": "1000"
        }
      },
      "description": "A map of strings in JSON format with custom keys and string values. Represents transaction properties."
    },
    "txnId": {
      "type": "string",
      "description": "A unique transaction identification number. <br>**Note:** If the specified `txnId` already exists, a `409` error code \"Entity already exists\" is returned. To update an existing transaction, use the [bulk import method](doc:update-transactions-via-bulk-import-method)."
    },
    "txnDate": {
      "type": "string",
      "format": "date",
      "description": "Date and time when the transaction was initiated (format `yyyy-MM-dd HH:mm:ss+XXXX`, e.g. 2022-11-24 23:37:02+0000)."
    },
    "applicant": {
      "type": "object",
      "required": [
        "externalUserId",
        "fullName",
        "type"
      ],
      "properties": {
        "type": {
          "type": "string",
          "default": "individual",
          "description": "Participant entity type: `company` or `individual`. Set to `individual` by default."
        },
        "device": {
          "type": "object",
          "properties": {
            "coords": {
              "type": "object",
              "properties": {
                "lat": {
                  "type": "number",
                  "format": "double",
                  "description": "Position latitude in decimal degrees."
                },
                "lon": {
                  "type": "number",
                  "format": "double",
                  "description": "Position longitude in decimal degrees."
                },
                "accuracy": {
                  "type": "string",
                  "description": "Accuracy of the latitude and longitude properties, expressed in meters. #"
                }
              },
              "description": "Coordinates."
            },
            "ipInfo": {
              "type": "object",
              "properties": {
                "ip": {
                  "type": "string",
                  "description": "IP address."
                },
                "asn": {
                  "type": "integer",
                  "format": "int32",
                  "description": "ASN."
                },
                "lat": {
                  "type": "number",
                  "format": "double",
                  "description": "Position latitude in decimal degrees."
                },
                "lon": {
                  "type": "number",
                  "format": "double",
                  "description": "Position longitude in decimal degrees."
                },
                "asnOrg": {
                  "type": "string",
                  "description": "ASN organisation."
                },
                "riskyAsn": {
                  "type": "boolean",
                  "description": "ASN is risky or not."
                },
                "countryCode3": {
                  "type": "string",
                  "description": "Country Alpha-3 code."
                }
              },
              "description": "Data about used IP address."
            },
            "address": {
              "type": "object",
              "properties": {
                "town": {
                  "type": "string",
                  "description": "Town or city name."
                },
                "state": {
                  "type": "string",
                  "description": "State name (if applicable)."
                },
                "street": {
                  "type": "string",
                  "description": "Street name."
                },
                "country": {
                  "type": "string",
                  "description": "Alpha-3 country code."
                },
                "postCode": {
                  "type": "string",
                  "description": "Postal code."
                },
                "subStreet": {
                  "type": "string",
                  "description": "Additional street information."
                },
                "flatNumber": {
                  "type": "string",
                  "description": "Flat or apartment number."
                },
                "buildingName": {
                  "type": "string",
                  "description": "Building name (if applicable)."
                },
                "buildingNumber": {
                  "type": "string",
                  "description": "Building number."
                }
              },
              "description": "Device address."
            },
            "platform": {
              "type": "string",
              "description": "Device platform, e.g. `Mobile Android`."
            },
            "sessionId": {
              "type": "string",
              "description": "Transaction session identifier."
            },
            "userAgent": {
              "type": "string",
              "description": "Device user agent."
            },
            "acceptLang": {
              "type": "string",
              "description": "From browser, e.g. `en`."
            },
            "fingerprint": {
              "type": "string",
              "description": "Device fingerprint."
            },
            "sessionAgeMs": {
              "type": "integer",
              "format": "int64",
              "description": "Session lifetime in milliseconds."
            }
          },
          "description": "Device information."
        },
        "address": {
          "type": "object",
          "properties": {
            "town": {
              "type": "string",
              "description": "Town or city name."
            },
            "state": {
              "type": "string",
              "description": "State name (if applicable)."
            },
            "street": {
              "type": "string",
              "description": "Street name."
            },
            "country": {
              "type": "string",
              "description": "Alpha-3 country code."
            },
            "postCode": {
              "type": "string",
              "description": "Postal code."
            },
            "subStreet": {
              "type": "string",
              "description": "Additional street information."
            },
            "flatNumber": {
              "type": "string",
              "description": "Flat or apartment number."
            },
            "buildingName": {
              "type": "string",
              "description": "Building name (if applicable)."
            },
            "buildingNumber": {
              "type": "string",
              "description": "Building number."
            }
          },
          "description": "Participant address."
        },
        "fullName": {
          "type": "string",
          "description": "Full name of the participant."
        },
        "paymentMethod": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "description": "Payment method type: `card`/`account`/`crypto`."
            },
            "2faUsed": {
              "type": "boolean",
              "description": "Indication of 2fa being used."
            },
            "3dsUsed": {
              "type": "boolean",
              "description": "Indication of 3d secure auth being used."
            },
            "accountId": {
              "type": "string",
              "description": "Representation of the account ID: Account number, IBAN or DC hash for `card`, crypto wallet address for `crypto` type etc."
            },
            "issuingCountry": {
              "type": "string",
              "description": "The payment issuing country code in Alpha-3 format."
            }
          },
          "description": "Information about the payment method."
        },
        "externalUserId": {
          "type": "string",
          "description": "An external identifier of the transaction participant (applicant or counterparty). Each participant must have a unique identifier that must be reused during all subsequent transactions. Make sure to use the same `externalUserID` for the same counterparty or applicant."
        },
        "institutionInfo": {
          "type": "object",
          "properties": {
            "code": {
              "type": "string",
              "description": "Transaction institution code."
            },
            "name": {
              "type": "string",
              "description": "Transaction institution name."
            },
            "address": {
              "type": "object",
              "properties": {
                "town": {
                  "type": "string",
                  "description": "Town or city name."
                },
                "state": {
                  "type": "string",
                  "description": "State name (if applicable)."
                },
                "street": {
                  "type": "string",
                  "description": "Street name."
                },
                "country": {
                  "type": "string",
                  "description": "Alpha-3 country code."
                },
                "postCode": {
                  "type": "string",
                  "description": "Postal code."
                },
                "subStreet": {
                  "type": "string",
                  "description": "Additional street information."
                },
                "flatNumber": {
                  "type": "string",
                  "description": "Flat or apartment number."
                },
                "buildingName": {
                  "type": "string",
                  "description": "Building name (if applicable)."
                },
                "buildingNumber": {
                  "type": "string",
                  "description": "Building number."
                }
              },
              "description": "Transaction institution address."
            },
            "internalId": {
              "type": "string",
              "description": "VASP ID for counterparty transaction. If provided, we trust the exchange and use the expected VASP for transaction approval."
            }
          },
          "description": "Transaction institution information"
        }
      },
      "description": "Transaction participant data with mandatory `applicantId` (sender or remitter, depending on `info.direction`)."
    },
    "sourceKey": {
      "type": "string",
      "description": "A source key indication to separate access to transactions."
    },
    "counterparty": {
      "type": "object",
      "required": [
        "externalUserId",
        "fullName",
        "type"
      ],
      "properties": {
        "type": {
          "type": "string",
          "default": "individual",
          "description": "Participant entity type: `company` or `individual`. Set to `individual` by default."
        },
        "device": {
          "type": "object",
          "properties": {
            "coords": {
              "type": "object",
              "properties": {
                "lat": {
                  "type": "number",
                  "format": "double",
                  "description": "Position latitude in decimal degrees."
                },
                "lon": {
                  "type": "number",
                  "format": "double",
                  "description": "Position longitude in decimal degrees."
                },
                "accuracy": {
                  "type": "string",
                  "description": "Accuracy of the latitude and longitude properties, expressed in meters. #"
                }
              },
              "description": "Coordinates."
            },
            "ipInfo": {
              "type": "object",
              "properties": {
                "ip": {
                  "type": "string",
                  "description": "IP address."
                },
                "asn": {
                  "type": "integer",
                  "format": "int32",
                  "description": "ASN."
                },
                "lat": {
                  "type": "number",
                  "format": "double",
                  "description": "Position latitude in decimal degrees."
                },
                "lon": {
                  "type": "number",
                  "format": "double",
                  "description": "Position longitude in decimal degrees."
                },
                "asnOrg": {
                  "type": "string",
                  "description": "ASN organisation."
                },
                "riskyAsn": {
                  "type": "boolean",
                  "description": "ASN is risky or not."
                },
                "countryCode3": {
                  "type": "string",
                  "description": "Country Alpha-3 code."
                }
              },
              "description": "Data about used IP address."
            },
            "address": {
              "type": "object",
              "properties": {
                "town": {
                  "type": "string",
                  "description": "Town or city name."
                },
                "state": {
                  "type": "string",
                  "description": "State name (if applicable)."
                },
                "street": {
                  "type": "string",
                  "description": "Street name."
                },
                "country": {
                  "type": "string",
                  "description": "Alpha-3 country code."
                },
                "postCode": {
                  "type": "string",
                  "description": "Postal code."
                },
                "subStreet": {
                  "type": "string",
                  "description": "Additional street information."
                },
                "flatNumber": {
                  "type": "string",
                  "description": "Flat or apartment number."
                },
                "buildingName": {
                  "type": "string",
                  "description": "Building name (if applicable)."
                },
                "buildingNumber": {
                  "type": "string",
                  "description": "Building number."
                }
              },
              "description": "Device address."
            },
            "platform": {
              "type": "string",
              "description": "Device platform, e.g. `Mobile Android`."
            },
            "sessionId": {
              "type": "string",
              "description": "Transaction session identifier."
            },
            "userAgent": {
              "type": "string",
              "description": "Device user agent."
            },
            "acceptLang": {
              "type": "string",
              "description": "From browser, e.g. `en`."
            },
            "fingerprint": {
              "type": "string",
              "description": "Device fingerprint."
            },
            "sessionAgeMs": {
              "type": "integer",
              "format": "int64",
              "description": "Session lifetime in milliseconds."
            }
          },
          "description": "Device information."
        },
        "address": {
          "type": "object",
          "properties": {
            "town": {
              "type": "string",
              "description": "Town or city name."
            },
            "state": {
              "type": "string",
              "description": "State name (if applicable)."
            },
            "street": {
              "type": "string",
              "description": "Street name."
            },
            "country": {
              "type": "string",
              "description": "Alpha-3 country code."
            },
            "postCode": {
              "type": "string",
              "description": "Postal code."
            },
            "subStreet": {
              "type": "string",
              "description": "Additional street information."
            },
            "flatNumber": {
              "type": "string",
              "description": "Flat or apartment number."
            },
            "buildingName": {
              "type": "string",
              "description": "Building name (if applicable)."
            },
            "buildingNumber": {
              "type": "string",
              "description": "Building number."
            }
          },
          "description": "Participant address."
        },
        "fullName": {
          "type": "string",
          "description": "Full name of the participant."
        },
        "paymentMethod": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "description": "Payment method type: `card`/`account`/`crypto`."
            },
            "2faUsed": {
              "type": "boolean",
              "description": "Indication of 2fa being used."
            },
            "3dsUsed": {
              "type": "boolean",
              "description": "Indication of 3d secure auth being used."
            },
            "accountId": {
              "type": "string",
              "description": "Representation of the account ID: Account number, IBAN or DC hash for `card`, crypto wallet address for `crypto` type etc."
            },
            "issuingCountry": {
              "type": "string",
              "description": "The payment issuing country code in Alpha-3 format."
            }
          },
          "description": "Information about the payment method."
        },
        "externalUserId": {
          "type": "string",
          "description": "An external identifier of the transaction participant (applicant or counterparty). Each participant must have a unique identifier that must be reused during all subsequent transactions. Make sure to use the same `externalUserID` for the same counterparty or applicant."
        },
        "institutionInfo": {
          "type": "object",
          "properties": {
            "code": {
              "type": "string",
              "description": "Transaction institution code."
            },
            "name": {
              "type": "string",
              "description": "Transaction institution name."
            },
            "address": {
              "type": "object",
              "properties": {
                "town": {
                  "type": "string",
                  "description": "Town or city name."
                },
                "state": {
                  "type": "string",
                  "description": "State name (if applicable)."
                },
                "street": {
                  "type": "string",
                  "description": "Street name."
                },
                "country": {
                  "type": "string",
                  "description": "Alpha-3 country code."
                },
                "postCode": {
                  "type": "string",
                  "description": "Postal code."
                },
                "subStreet": {
                  "type": "string",
                  "description": "Additional street information."
                },
                "flatNumber": {
                  "type": "string",
                  "description": "Flat or apartment number."
                },
                "buildingName": {
                  "type": "string",
                  "description": "Building name (if applicable)."
                },
                "buildingNumber": {
                  "type": "string",
                  "description": "Building number."
                }
              },
              "description": "Transaction institution address."
            },
            "internalId": {
              "type": "string",
              "description": "VASP ID for counterparty transaction. If provided, we trust the exchange and use the expected VASP for transaction approval."
            }
          },
          "description": "Transaction institution information"
        }
      },
      "description": "Transaction participant data (sender or remitter, depending on `info.direction`)."
    }
  }
}
object ApplicantSubmitTransactionDataRequest1 
{
  "type": "object",
  "required": [
    "txnId",
    "info",
    "applicant",
    "counterparty"
  ],
  "properties": {
    "info": {
      "type": "object",
      "required": [
        "direction",
        "amount",
        "currencyCode"
      ],
      "properties": {
        "type": {
          "type": "string",
          "description": "Accepts any value that helps you categorize transactions. For example, for gambling transactions, you can specify `bonus`, `payroll`, or `cashback`."
        },
        "amount": {
          "type": "number",
          "format": "double",
          "description": "The amount of funds used in this transaction."
        },
        "direction": {
          "type": "string",
          "description": "Can be `out` (applicant sends to counterparty) or `in` (counterparty sends to applicant)."
        },
        "cryptoParams": {
          "type": "object",
          "required": [
            "attemptId"
          ],
          "properties": {
            "attemptId": {
              "type": "string",
              "description": "Unique identifier of the transaction attempt."
            },
            "cryptoChain": {
              "type": "string",
              "description": "The crypto chain name. Mandatory for crypto tokens only. Specifies the network name to which the token at `currencyCode` belongs. Empty for native tokens (e.g. for `BTC`, `ETH`). For more information, see [chain codes](ref:crypto-chain-codes)."
            },
            "outputIndex": {
              "type": "integer",
              "format": "int32",
              "description": "An index number for a transaction output."
            }
          },
          "description": "Includes crypto transaction parameters. It is crucial for Sumsub to understand which crypto chain is used to correctly utilize the data."
        },
        "currencyCode": {
          "type": "string",
          "description": "Currency code (`USD`, `GBP`, `BTC`, etc)."
        },
        "currencyType": {
          "type": "string",
          "description": "Indicates whether the transaction is `crypto` or `fiat`."
        },
        "paymentTxnId": {
          "type": "string",
          "description": "Crypto transaction ID from the blockchain. Required for crypto check requests only."
        },
        "paymentDetails": {
          "type": "string",
          "description": "A comment with payment details."
        },
        "amountInDefaultCurrency": {
          "type": "number",
          "format": "double",
          "description": "The amount of funds used in this transaction in the default currency. For more precise calculations, you can submit already converted default currency amount in this field."
        }
      },
      "description": "An object representing transaction information."
    },
    "type": {
      "type": "string",
      "default": "finance",
      "description": "A transaction type. Expects values: </br> <ul>   <li><code>finance</code>(default)</li>   <li><code>gamblingBet</code></li>   <li><code>gamblingLimitChange</code></li>   <li><code>gamblingBonusChange</code></li>   <li><code>kyc</code></li>   <li><code>travelRule</code></li>   <li><code>userPlatformEvent</code></li>   <ul>     <li><code>login</code></li>     <li><code>signup</code></li>     <li><code>passwordChange</code></li>     <li><code>twoFaReset</code></li>   </ul> </ul>"
    },
    "props": {
      "type": "object",
      "properties": {
        "customTxnLimit": {
          "type": "string",
          "default": "1000"
        }
      },
      "description": "A map of strings in JSON format with custom keys and string values. Represents transaction properties."
    },
    "txnId": {
      "type": "string",
      "description": "A unique transaction identification number. <br>**Note:** If the specified `txnId` already exists, a `409` error code \"Entity already exists\" is returned. To update an existing transaction, use the [bulk import method](doc:update-transactions-via-bulk-import-method)."
    },
    "txnDate": {
      "type": "string",
      "format": "date",
      "description": "Date and time when the transaction was initiated (format `yyyy-MM-dd HH:mm:ss+XXXX`, e.g. 2022-11-24 23:37:02+0000)."
    },
    "applicant": {
      "type": "object",
      "required": [
        "externalUserId",
        "fullName",
        "type"
      ],
      "properties": {
        "type": {
          "type": "string",
          "default": "individual",
          "description": "Participant entity type: `company` or `individual`. Set to `individual` by default."
        },
        "device": {
          "type": "object",
          "properties": {
            "coords": {
              "type": "object",
              "properties": {
                "lat": {
                  "type": "number",
                  "format": "double",
                  "description": "Position latitude in decimal degrees."
                },
                "lon": {
                  "type": "number",
                  "format": "double",
                  "description": "Position longitude in decimal degrees."
                },
                "accuracy": {
                  "type": "string",
                  "description": "Accuracy of the latitude and longitude properties, expressed in meters. #"
                }
              },
              "description": "Coordinates."
            },
            "ipInfo": {
              "type": "object",
              "properties": {
                "ip": {
                  "type": "string",
                  "description": "IP address."
                },
                "asn": {
                  "type": "integer",
                  "format": "int32",
                  "description": "ASN."
                },
                "lat": {
                  "type": "number",
                  "format": "double",
                  "description": "Position latitude in decimal degrees."
                },
                "lon": {
                  "type": "number",
                  "format": "double",
                  "description": "Position longitude in decimal degrees."
                },
                "asnOrg": {
                  "type": "string",
                  "description": "ASN organisation."
                },
                "riskyAsn": {
                  "type": "boolean",
                  "description": "ASN is risky or not."
                },
                "countryCode3": {
                  "type": "string",
                  "description": "Country Alpha-3 code."
                }
              },
              "description": "Data about used IP address."
            },
            "address": {
              "type": "object",
              "properties": {
                "town": {
                  "type": "string",
                  "description": "Town or city name."
                },
                "state": {
                  "type": "string",
                  "description": "State name (if applicable)."
                },
                "street": {
                  "type": "string",
                  "description": "Street name."
                },
                "country": {
                  "type": "string",
                  "description": "Alpha-3 country code."
                },
                "postCode": {
                  "type": "string",
                  "description": "Postal code."
                },
                "subStreet": {
                  "type": "string",
                  "description": "Additional street information."
                },
                "flatNumber": {
                  "type": "string",
                  "description": "Flat or apartment number."
                },
                "buildingName": {
                  "type": "string",
                  "description": "Building name (if applicable)."
                },
                "buildingNumber": {
                  "type": "string",
                  "description": "Building number."
                }
              },
              "description": "Device address."
            },
            "platform": {
              "type": "string",
              "description": "Device platform, e.g. `Mobile Android`."
            },
            "sessionId": {
              "type": "string",
              "description": "Transaction session identifier."
            },
            "userAgent": {
              "type": "string",
              "description": "Device user agent."
            },
            "acceptLang": {
              "type": "string",
              "description": "From browser, e.g. `en`."
            },
            "fingerprint": {
              "type": "string",
              "description": "Device fingerprint."
            },
            "sessionAgeMs": {
              "type": "integer",
              "format": "int64",
              "description": "Session lifetime in milliseconds."
            }
          },
          "description": "Device information."
        },
        "address": {
          "type": "object",
          "properties": {
            "town": {
              "type": "string",
              "description": "Town or city name."
            },
            "state": {
              "type": "string",
              "description": "State name (if applicable)."
            },
            "street": {
              "type": "string",
              "description": "Street name."
            },
            "country": {
              "type": "string",
              "description": "Alpha-3 country code."
            },
            "postCode": {
              "type": "string",
              "description": "Postal code."
            },
            "subStreet": {
              "type": "string",
              "description": "Additional street information."
            },
            "flatNumber": {
              "type": "string",
              "description": "Flat or apartment number."
            },
            "buildingName": {
              "type": "string",
              "description": "Building name (if applicable)."
            },
            "buildingNumber": {
              "type": "string",
              "description": "Building number."
            }
          },
          "description": "Participant address."
        },
        "fullName": {
          "type": "string",
          "description": "Full name of the participant."
        },
        "paymentMethod": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "description": "Payment method type: `card`/`account`/`crypto`."
            },
            "2faUsed": {
              "type": "boolean",
              "description": "Indication of 2fa being used."
            },
            "3dsUsed": {
              "type": "boolean",
              "description": "Indication of 3d secure auth being used."
            },
            "accountId": {
              "type": "string",
              "description": "Representation of the account ID: Account number, IBAN or DC hash for `card`, crypto wallet address for `crypto` type etc."
            },
            "issuingCountry": {
              "type": "string",
              "description": "The payment issuing country code in Alpha-3 format."
            }
          },
          "description": "Information about the payment method."
        },
        "externalUserId": {
          "type": "string",
          "description": "An external identifier of the transaction participant (applicant or counterparty). Each participant must have a unique identifier that must be reused during all subsequent transactions. Make sure to use the same `externalUserID` for the same counterparty or applicant."
        },
        "institutionInfo": {
          "type": "object",
          "properties": {
            "code": {
              "type": "string",
              "description": "Transaction institution code."
            },
            "name": {
              "type": "string",
              "description": "Transaction institution name."
            },
            "address": {
              "type": "object",
              "properties": {
                "town": {
                  "type": "string",
                  "description": "Town or city name."
                },
                "state": {
                  "type": "string",
                  "description": "State name (if applicable)."
                },
                "street": {
                  "type": "string",
                  "description": "Street name."
                },
                "country": {
                  "type": "string",
                  "description": "Alpha-3 country code."
                },
                "postCode": {
                  "type": "string",
                  "description": "Postal code."
                },
                "subStreet": {
                  "type": "string",
                  "description": "Additional street information."
                },
                "flatNumber": {
                  "type": "string",
                  "description": "Flat or apartment number."
                },
                "buildingName": {
                  "type": "string",
                  "description": "Building name (if applicable)."
                },
                "buildingNumber": {
                  "type": "string",
                  "description": "Building number."
                }
              },
              "description": "Transaction institution address."
            },
            "internalId": {
              "type": "string",
              "description": "VASP ID for counterparty transaction. If provided, we trust the exchange and use the expected VASP for transaction approval."
            }
          },
          "description": "Transaction institution information"
        }
      },
      "description": "Transaction participant data with mandatory `applicantId` (sender or remitter, depending on `info.direction`)."
    },
    "sourceKey": {
      "type": "string",
      "description": "A source key indication to separate access to transactions."
    },
    "counterparty": {
      "type": "object",
      "required": [
        "externalUserId",
        "fullName",
        "type"
      ],
      "properties": {
        "type": {
          "type": "string",
          "default": "individual",
          "description": "Participant entity type: `company` or `individual`. Set to `individual` by default."
        },
        "device": {
          "type": "object",
          "properties": {
            "coords": {
              "type": "object",
              "properties": {
                "lat": {
                  "type": "number",
                  "format": "double",
                  "description": "Position latitude in decimal degrees."
                },
                "lon": {
                  "type": "number",
                  "format": "double",
                  "description": "Position longitude in decimal degrees."
                },
                "accuracy": {
                  "type": "string",
                  "description": "Accuracy of the latitude and longitude properties, expressed in meters. #"
                }
              },
              "description": "Coordinates."
            },
            "ipInfo": {
              "type": "object",
              "properties": {
                "ip": {
                  "type": "string",
                  "description": "IP address."
                },
                "asn": {
                  "type": "integer",
                  "format": "int32",
                  "description": "ASN."
                },
                "lat": {
                  "type": "number",
                  "format": "double",
                  "description": "Position latitude in decimal degrees."
                },
                "lon": {
                  "type": "number",
                  "format": "double",
                  "description": "Position longitude in decimal degrees."
                },
                "asnOrg": {
                  "type": "string",
                  "description": "ASN organisation."
                },
                "riskyAsn": {
                  "type": "boolean",
                  "description": "ASN is risky or not."
                },
                "countryCode3": {
                  "type": "string",
                  "description": "Country Alpha-3 code."
                }
              },
              "description": "Data about used IP address."
            },
            "address": {
              "type": "object",
              "properties": {
                "town": {
                  "type": "string",
                  "description": "Town or city name."
                },
                "state": {
                  "type": "string",
                  "description": "State name (if applicable)."
                },
                "street": {
                  "type": "string",
                  "description": "Street name."
                },
                "country": {
                  "type": "string",
                  "description": "Alpha-3 country code."
                },
                "postCode": {
                  "type": "string",
                  "description": "Postal code."
                },
                "subStreet": {
                  "type": "string",
                  "description": "Additional street information."
                },
                "flatNumber": {
                  "type": "string",
                  "description": "Flat or apartment number."
                },
                "buildingName": {
                  "type": "string",
                  "description": "Building name (if applicable)."
                },
                "buildingNumber": {
                  "type": "string",
                  "description": "Building number."
                }
              },
              "description": "Device address."
            },
            "platform": {
              "type": "string",
              "description": "Device platform, e.g. `Mobile Android`."
            },
            "sessionId": {
              "type": "string",
              "description": "Transaction session identifier."
            },
            "userAgent": {
              "type": "string",
              "description": "Device user agent."
            },
            "acceptLang": {
              "type": "string",
              "description": "From browser, e.g. `en`."
            },
            "fingerprint": {
              "type": "string",
              "description": "Device fingerprint."
            },
            "sessionAgeMs": {
              "type": "integer",
              "format": "int64",
              "description": "Session lifetime in milliseconds."
            }
          },
          "description": "Device information."
        },
        "address": {
          "type": "object",
          "properties": {
            "town": {
              "type": "string",
              "description": "Town or city name."
            },
            "state": {
              "type": "string",
              "description": "State name (if applicable)."
            },
            "street": {
              "type": "string",
              "description": "Street name."
            },
            "country": {
              "type": "string",
              "description": "Alpha-3 country code."
            },
            "postCode": {
              "type": "string",
              "description": "Postal code."
            },
            "subStreet": {
              "type": "string",
              "description": "Additional street information."
            },
            "flatNumber": {
              "type": "string",
              "description": "Flat or apartment number."
            },
            "buildingName": {
              "type": "string",
              "description": "Building name (if applicable)."
            },
            "buildingNumber": {
              "type": "string",
              "description": "Building number."
            }
          },
          "description": "Participant address."
        },
        "fullName": {
          "type": "string",
          "description": "Full name of the participant."
        },
        "paymentMethod": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "description": "Payment method type: `card`/`account`/`crypto`."
            },
            "2faUsed": {
              "type": "boolean",
              "description": "Indication of 2fa being used."
            },
            "3dsUsed": {
              "type": "boolean",
              "description": "Indication of 3d secure auth being used."
            },
            "accountId": {
              "type": "string",
              "description": "Representation of the account ID: Account number, IBAN or DC hash for `card`, crypto wallet address for `crypto` type etc."
            },
            "issuingCountry": {
              "type": "string",
              "description": "The payment issuing country code in Alpha-3 format."
            }
          },
          "description": "Information about the payment method."
        },
        "externalUserId": {
          "type": "string",
          "description": "An external identifier of the transaction participant (applicant or counterparty). Each participant must have a unique identifier that must be reused during all subsequent transactions. Make sure to use the same `externalUserID` for the same counterparty or applicant."
        },
        "institutionInfo": {
          "type": "object",
          "properties": {
            "code": {
              "type": "string",
              "description": "Transaction institution code."
            },
            "name": {
              "type": "string",
              "description": "Transaction institution name."
            },
            "address": {
              "type": "object",
              "properties": {
                "town": {
                  "type": "string",
                  "description": "Town or city name."
                },
                "state": {
                  "type": "string",
                  "description": "State name (if applicable)."
                },
                "street": {
                  "type": "string",
                  "description": "Street name."
                },
                "country": {
                  "type": "string",
                  "description": "Alpha-3 country code."
                },
                "postCode": {
                  "type": "string",
                  "description": "Postal code."
                },
                "subStreet": {
                  "type": "string",
                  "description": "Additional street information."
                },
                "flatNumber": {
                  "type": "string",
                  "description": "Flat or apartment number."
                },
                "buildingName": {
                  "type": "string",
                  "description": "Building name (if applicable)."
                },
                "buildingNumber": {
                  "type": "string",
                  "description": "Building number."
                }
              },
              "description": "Transaction institution address."
            },
            "internalId": {
              "type": "string",
              "description": "VASP ID for counterparty transaction. If provided, we trust the exchange and use the expected VASP for transaction approval."
            }
          },
          "description": "Transaction institution information"
        }
      },
      "description": "Transaction participant data (sender or remitter, depending on `info.direction`)."
    }
  }
}
object ApplicantSubmitTransactionForNonExistingRequest 
{
  "type": "object",
  "required": [
    "txnId",
    "info",
    "applicant",
    "counterparty"
  ],
  "properties": {
    "info": {
      "type": "object",
      "required": [
        "direction",
        "amount",
        "currencyCode"
      ],
      "properties": {
        "type": {
          "type": "string",
          "description": "Accepts any value that helps you categorize transactions. For example, for gambling transactions, you can specify `bonus`, `payroll`, or `cashback`."
        },
        "amount": {
          "type": "number",
          "format": "double",
          "description": "The amount of funds used in this transaction."
        },
        "direction": {
          "type": "string",
          "description": "Can be `out` (applicant sends to counterparty) or `in` (counterparty sends to applicant)."
        },
        "cryptoParams": {
          "type": "object",
          "required": [
            "attemptId"
          ],
          "properties": {
            "attemptId": {
              "type": "string",
              "description": "Unique identifier of the transaction attempt."
            },
            "cryptoChain": {
              "type": "string",
              "description": "The crypto chain name. Mandatory for crypto tokens only. Specifies the network name to which the token at `currencyCode` belongs. Empty for native tokens (e.g. for `BTC`, `ETH`). For more information, see [chain codes](ref:crypto-chain-codes)."
            },
            "outputIndex": {
              "type": "integer",
              "format": "int32",
              "description": "An index number for a transaction output."
            }
          },
          "description": "Includes crypto transaction parameters. It is crucial for Sumsub to understand which crypto chain is used to correctly utilize the data."
        },
        "currencyCode": {
          "type": "string",
          "description": "Currency code (`USD`, `GBP`, `BTC`, etc)."
        },
        "currencyType": {
          "type": "string",
          "description": "Indicates whether the transaction is `crypto` or `fiat`."
        },
        "paymentTxnId": {
          "type": "string",
          "description": "Crypto transaction ID from the blockchain. Required for crypto check requests only."
        },
        "paymentDetails": {
          "type": "string",
          "description": "A comment with payment details."
        },
        "amountInDefaultCurrency": {
          "type": "number",
          "format": "double",
          "description": "The amount of funds used in this transaction in the default currency. For more precise calculations, you can submit already converted default currency amount in this field."
        }
      },
      "description": "An object representing transaction information."
    },
    "type": {
      "type": "string",
      "default": "finance",
      "description": "A transaction type. Expects values: </br> <ul>   <li><code>finance</code>(default)</li>   <li><code>gamblingBet</code></li>   <li><code>gamblingLimitChange</code></li>   <li><code>gamblingBonusChange</code></li>   <li><code>kyc</code></li>   <li><code>travelRule</code></li>   <li><code>userPlatformEvent</code></li>   <ul>     <li><code>login</code></li>     <li><code>signup</code></li>     <li><code>passwordChange</code></li>     <li><code>twoFaReset</code></li>   </ul> </ul>"
    },
    "props": {
      "type": "object",
      "properties": {},
      "description": "Transaction properties. Map of strings (JSON) of custom keys and string values."
    },
    "txnId": {
      "type": "string",
      "description": "A unique transaction identification number."
    },
    "txnDate": {
      "type": "string",
      "format": "date",
      "description": "Date and time when the transaction was initiated (format `yyyy-MM-dd HH:mm:ss+XXXX`, e.g. 2022-11-24 23:37:02+0000)."
    },
    "applicant": {
      "type": "object",
      "required": [
        "externalUserId",
        "fullName",
        "type"
      ],
      "properties": {
        "type": {
          "type": "string",
          "default": "individual",
          "description": "Participant entity type: `company` or `individual`. Set to `individual` by default."
        },
        "device": {
          "type": "object",
          "properties": {
            "coords": {
              "type": "object",
              "properties": {
                "lat": {
                  "type": "number",
                  "format": "double",
                  "description": "Position latitude in decimal degrees."
                },
                "lon": {
                  "type": "number",
                  "format": "double",
                  "description": "Position longitude in decimal degrees."
                },
                "accuracy": {
                  "type": "string",
                  "description": "Accuracy of the latitude and longitude properties, expressed in meters. #"
                }
              },
              "description": "Coordinates."
            },
            "ipInfo": {
              "type": "object",
              "properties": {
                "ip": {
                  "type": "string",
                  "description": "IP address."
                },
                "asn": {
                  "type": "integer",
                  "format": "int32",
                  "description": "ASN."
                },
                "lat": {
                  "type": "number",
                  "format": "double",
                  "description": "Position latitude in decimal degrees."
                },
                "lon": {
                  "type": "number",
                  "format": "double",
                  "description": "Position longitude in decimal degrees."
                },
                "asnOrg": {
                  "type": "string",
                  "description": "ASN organisation."
                },
                "riskyAsn": {
                  "type": "boolean",
                  "description": "ASN is risky or not."
                },
                "countryCode3": {
                  "type": "string",
                  "description": "Country Alpha-3 code."
                }
              },
              "description": "Data about used IP address."
            },
            "address": {
              "type": "object",
              "properties": {
                "town": {
                  "type": "string",
                  "description": "Town or city name."
                },
                "state": {
                  "type": "string",
                  "description": "State name (if applicable)."
                },
                "street": {
                  "type": "string",
                  "description": "Street name."
                },
                "country": {
                  "type": "string",
                  "description": "Alpha-3 country code."
                },
                "postCode": {
                  "type": "string",
                  "description": "Postal code."
                },
                "subStreet": {
                  "type": "string",
                  "description": "Additional street information."
                },
                "flatNumber": {
                  "type": "string",
                  "description": "Flat or apartment number."
                },
                "buildingName": {
                  "type": "string",
                  "description": "Building name (if applicable)."
                },
                "buildingNumber": {
                  "type": "string",
                  "description": "Building number."
                }
              },
              "description": "Device address."
            },
            "platform": {
              "type": "string",
              "description": "Device platform, e.g. `Mobile Android`."
            },
            "sessionId": {
              "type": "string",
              "description": "Transaction session identifier."
            },
            "userAgent": {
              "type": "string",
              "description": "Device user agent."
            },
            "acceptLang": {
              "type": "string",
              "description": "From browser, e.g. `en`."
            },
            "fingerprint": {
              "type": "string",
              "description": "Device fingerprint."
            },
            "sessionAgeMs": {
              "type": "integer",
              "format": "int64",
              "description": "Session lifetime in milliseconds."
            }
          },
          "description": "Device information."
        },
        "address": {
          "type": "object",
          "properties": {
            "town": {
              "type": "string",
              "description": "Town or city name."
            },
            "state": {
              "type": "string",
              "description": "State name (if applicable)."
            },
            "street": {
              "type": "string",
              "description": "Street name."
            },
            "country": {
              "type": "string",
              "description": "Alpha-3 country code."
            },
            "postCode": {
              "type": "string",
              "description": "Postal code."
            },
            "subStreet": {
              "type": "string",
              "description": "Additional street information."
            },
            "flatNumber": {
              "type": "string",
              "description": "Flat or apartment number."
            },
            "buildingName": {
              "type": "string",
              "description": "Building name (if applicable)."
            },
            "buildingNumber": {
              "type": "string",
              "description": "Building number."
            }
          },
          "description": "Participant address."
        },
        "fullName": {
          "type": "string",
          "description": "Full name of the participant."
        },
        "paymentMethod": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "description": "Payment method type: `card`/`account`/`crypto`."
            },
            "2faUsed": {
              "type": "boolean",
              "description": "Indication of 2fa being used."
            },
            "3dsUsed": {
              "type": "boolean",
              "description": "Indication of 3d secure auth being used."
            },
            "accountId": {
              "type": "string",
              "description": "Representation of the account ID: Account number, IBAN or DC hash for `card`, crypto wallet address for `crypto` type etc."
            },
            "issuingCountry": {
              "type": "string",
              "description": "The payment issuing country code in Alpha-3 format."
            }
          },
          "description": "Information about the payment method."
        },
        "externalUserId": {
          "type": "string",
          "description": "An external identifier of the transaction participant (applicant or counterparty). Each participant must have a unique identifier that must be reused during all subsequent transactions. Make sure to use the same `externalUserID` for the same counterparty or applicant."
        },
        "institutionInfo": {
          "type": "object",
          "properties": {
            "code": {
              "type": "string",
              "description": "Transaction institution code."
            },
            "name": {
              "type": "string",
              "description": "Transaction institution name."
            },
            "address": {
              "type": "object",
              "properties": {
                "town": {
                  "type": "string",
                  "description": "Town or city name."
                },
                "state": {
                  "type": "string",
                  "description": "State name (if applicable)."
                },
                "street": {
                  "type": "string",
                  "description": "Street name."
                },
                "country": {
                  "type": "string",
                  "description": "Alpha-3 country code."
                },
                "postCode": {
                  "type": "string",
                  "description": "Postal code."
                },
                "subStreet": {
                  "type": "string",
                  "description": "Additional street information."
                },
                "flatNumber": {
                  "type": "string",
                  "description": "Flat or apartment number."
                },
                "buildingName": {
                  "type": "string",
                  "description": "Building name (if applicable)."
                },
                "buildingNumber": {
                  "type": "string",
                  "description": "Building number."
                }
              },
              "description": "Transaction institution address."
            },
            "internalId": {
              "type": "string",
              "description": "VASP ID for counterparty transaction. If provided, we trust the exchange and use the expected VASP for transaction approval."
            }
          },
          "description": "Transaction institution information"
        }
      },
      "description": "Transaction participant data with mandatory `applicantId` (sender or remitter, depending on `info.direction`)."
    },
    "sourceKey": {
      "type": "string",
      "description": "A source key indication to separate access to transactions."
    },
    "counterparty": {
      "type": "object",
      "required": [
        "externalUserId",
        "fullName",
        "type"
      ],
      "properties": {
        "type": {
          "type": "string",
          "default": "individual",
          "description": "Participant entity type: `company` or `individual`. Set to `individual` by default."
        },
        "device": {
          "type": "object",
          "properties": {
            "coords": {
              "type": "object",
              "properties": {
                "lat": {
                  "type": "number",
                  "format": "double",
                  "description": "Position latitude in decimal degrees."
                },
                "lon": {
                  "type": "number",
                  "format": "double",
                  "description": "Position longitude in decimal degrees."
                },
                "accuracy": {
                  "type": "string",
                  "description": "Accuracy of the latitude and longitude properties, expressed in meters. #"
                }
              },
              "description": "Coordinates."
            },
            "ipInfo": {
              "type": "object",
              "properties": {
                "ip": {
                  "type": "string",
                  "description": "IP address."
                },
                "asn": {
                  "type": "integer",
                  "format": "int32",
                  "description": "ASN."
                },
                "lat": {
                  "type": "number",
                  "format": "double",
                  "description": "Position latitude in decimal degrees."
                },
                "lon": {
                  "type": "number",
                  "format": "double",
                  "description": "Position longitude in decimal degrees."
                },
                "asnOrg": {
                  "type": "string",
                  "description": "ASN organisation."
                },
                "riskyAsn": {
                  "type": "boolean",
                  "description": "ASN is risky or not."
                },
                "countryCode3": {
                  "type": "string",
                  "description": "Country Alpha-3 code."
                }
              },
              "description": "Data about used IP address."
            },
            "address": {
              "type": "object",
              "properties": {
                "town": {
                  "type": "string",
                  "description": "Town or city name."
                },
                "state": {
                  "type": "string",
                  "description": "State name (if applicable)."
                },
                "street": {
                  "type": "string",
                  "description": "Street name."
                },
                "country": {
                  "type": "string",
                  "description": "Alpha-3 country code."
                },
                "postCode": {
                  "type": "string",
                  "description": "Postal code."
                },
                "subStreet": {
                  "type": "string",
                  "description": "Additional street information."
                },
                "flatNumber": {
                  "type": "string",
                  "description": "Flat or apartment number."
                },
                "buildingName": {
                  "type": "string",
                  "description": "Building name (if applicable)."
                },
                "buildingNumber": {
                  "type": "string",
                  "description": "Building number."
                }
              },
              "description": "Device address."
            },
            "platform": {
              "type": "string",
              "description": "Device platform, e.g. `Mobile Android`."
            },
            "sessionId": {
              "type": "string",
              "description": "Transaction session identifier."
            },
            "userAgent": {
              "type": "string",
              "description": "Device user agent."
            },
            "acceptLang": {
              "type": "string",
              "description": "From browser, e.g. `en`."
            },
            "fingerprint": {
              "type": "string",
              "description": "Device fingerprint."
            },
            "sessionAgeMs": {
              "type": "integer",
              "format": "int64",
              "description": "Session lifetime in milliseconds."
            }
          },
          "description": "Device information."
        },
        "address": {
          "type": "object",
          "properties": {
            "town": {
              "type": "string",
              "description": "Town or city name."
            },
            "state": {
              "type": "string",
              "description": "State name (if applicable)."
            },
            "street": {
              "type": "string",
              "description": "Street name."
            },
            "country": {
              "type": "string",
              "description": "Alpha-3 country code."
            },
            "postCode": {
              "type": "string",
              "description": "Postal code."
            },
            "subStreet": {
              "type": "string",
              "description": "Additional street information."
            },
            "flatNumber": {
              "type": "string",
              "description": "Flat or apartment number."
            },
            "buildingName": {
              "type": "string",
              "description": "Building name (if applicable)."
            },
            "buildingNumber": {
              "type": "string",
              "description": "Building number."
            }
          },
          "description": "Participant address."
        },
        "fullName": {
          "type": "string",
          "description": "Full name of the participant."
        },
        "paymentMethod": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "description": "Payment method type: `card`/`account`/`crypto`."
            },
            "2faUsed": {
              "type": "boolean",
              "description": "Indication of 2fa being used."
            },
            "3dsUsed": {
              "type": "boolean",
              "description": "Indication of 3d secure auth being used."
            },
            "accountId": {
              "type": "string",
              "description": "Representation of the account ID: Account number, IBAN or DC hash for `card`, crypto wallet address for `crypto` type etc."
            },
            "issuingCountry": {
              "type": "string",
              "description": "The payment issuing country code in Alpha-3 format."
            }
          },
          "description": "Information about the payment method."
        },
        "externalUserId": {
          "type": "string",
          "description": "An external identifier of the transaction participant (applicant or counterparty). Each participant must have a unique identifier that must be reused during all subsequent transactions. Make sure to use the same `externalUserID` for the same counterparty or applicant."
        },
        "institutionInfo": {
          "type": "object",
          "properties": {
            "code": {
              "type": "string",
              "description": "Transaction institution code."
            },
            "name": {
              "type": "string",
              "description": "Transaction institution name."
            },
            "address": {
              "type": "object",
              "properties": {
                "town": {
                  "type": "string",
                  "description": "Town or city name."
                },
                "state": {
                  "type": "string",
                  "description": "State name (if applicable)."
                },
                "street": {
                  "type": "string",
                  "description": "Street name."
                },
                "country": {
                  "type": "string",
                  "description": "Alpha-3 country code."
                },
                "postCode": {
                  "type": "string",
                  "description": "Postal code."
                },
                "subStreet": {
                  "type": "string",
                  "description": "Additional street information."
                },
                "flatNumber": {
                  "type": "string",
                  "description": "Flat or apartment number."
                },
                "buildingName": {
                  "type": "string",
                  "description": "Building name (if applicable)."
                },
                "buildingNumber": {
                  "type": "string",
                  "description": "Building number."
                }
              },
              "description": "Transaction institution address."
            },
            "internalId": {
              "type": "string",
              "description": "VASP ID for counterparty transaction. If provided, we trust the exchange and use the expected VASP for transaction approval."
            }
          },
          "description": "Transaction institution information"
        }
      },
      "description": "Transaction participant data (sender or remitter, depending on `info.direction`)."
    }
  }
}
Load more schemas