openapi: 3.0.3 info: title: Sumsub API description: >- Sumsub is the one verification platform to secure the whole user journey. With Sumsub's customizable KYC, KYB, transaction monitoring and fraud prevention solutions, you can orchestrate your verification process, welcome more customers worldwide, meet compliance requirements, reduce costs and protect your business. Sumsub has over 2,000 clients in fintech, crypto, transportation, trading, e-commerce and gaming industries including Binance, Wirex, Avis, Bybit, Huobi, Unlimit, Flutter, Kaizen Gaming, and TransferGo. version: '1.0' x-konfig-ignore: object-with-no-properties: true potential-incorrect-type: true servers: - url: https://api.sumsub.com tags: - name: Applicant - name: Transaction - name: Check - name: Note - name: AccessToken - name: Image - name: Token - name: Verification - name: AuditTrailEvent - name: Health - name: Inspection - name: WebSDKLink - name: Analysis - name: Tag - name: VASP paths: /resources/status/api: get: tags: - Health summary: API health operationId: Health_statusApiGet description: Returns the operational status of the API. responses: '200': description: OK deprecated: false /resources/applicants: patch: tags: - Applicant summary: Change top-level information operationId: Applicant_updateTopLevelInfo description: Updates the existing verification level configuration. requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplicantUpdateTopLevelInfoRequest' multipart/form-data: schema: $ref: '#/components/schemas/ApplicantUpdateTopLevelInfoRequest1' responses: '200': description: OK deprecated: false /resources/applicants/{applicantId}/moveToLevel: post: tags: - Applicant summary: Change required documents operationId: Applicant_changeRequiredDocumentSet description: Changes the list of required documents. parameters: - description: >- A [verification level](https://docs.sumsub.com/reference) name. Case-sensitive and must be created in the same [environment](https://docs.sumsub.com/reference). If contains reserved characters (e.g., `@`, `+"`, white spaces as `%20`), it should be URL-encoded, otherwise you may get signature mismatch. name: name in: query required: true schema: type: string - description: A unique applicant identifier. name: applicantId in: path schema: type: string required: true responses: '200': description: OK deprecated: false /resources/applicants/{applicantId}/requiredIdDocs: post: tags: - Applicant summary: Get required ID documents operationId: Applicant_getRequiredIdDocs description: Returns the list of required documents. parameters: - description: A unique applicant identifier. name: applicantId in: path schema: type: string required: true responses: '200': description: OK deprecated: false /resources/applicants/{applicantId}/info/idDoc: post: tags: - Applicant summary: Add ID document operationId: Applicant_addIdDocument description: Adds an identification document to the verification flow. parameters: - description: '`true` / `false`' name: X-Return-Doc-Warnings in: header required: true schema: type: boolean - description: A unique applicant identifier. name: applicantId in: path schema: type: string required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplicantAddIdDocumentRequest' multipart/form-data: schema: $ref: '#/components/schemas/ApplicantAddIdDocumentRequest1' responses: '200': description: OK deprecated: false /resources/applicants/{applicantId}/fixedInfo: patch: tags: - Applicant summary: Change provided information operationId: Applicant_updateFixedInfo description: >- Updates personal applicant information collected via Web and Mobile SDKs. parameters: - description: A unique applicant identifier. name: applicantId in: path schema: type: string required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplicantUpdateFixedInfoRequest' multipart/form-data: schema: $ref: '#/components/schemas/ApplicantUpdateFixedInfoRequest1' responses: '200': description: OK deprecated: false /resources/applicants/{applicantId}/info: patch: tags: - Applicant summary: Change extracted information operationId: Applicant_changeExtractedInfo description: Updates personal applicant information extracted during verification. parameters: - description: A unique applicant identifier. name: applicantId in: path schema: type: string required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplicantChangeExtractedInfoRequest' multipart/form-data: schema: $ref: '#/components/schemas/ApplicantChangeExtractedInfoRequest1' responses: '200': description: OK deprecated: false /resources/applicants/-/ingestCompleted?levelName={levelName}: post: tags: - Applicant summary: Import applicants operationId: Applicant_importCompleted description: Imports applicants. parameters: - description: >- A [verification level](https://docs.sumsub.com/reference) name. Case-sensitive and must be created in the same [environment](https://docs.sumsub.com/reference). If contains reserved characters (e.g., `@`, `+"`, white spaces as `%20`), it should be URL-encoded, otherwise you may get signature mismatch. name: levelName in: query schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplicantImportCompletedRequest' multipart/form-data: schema: $ref: '#/components/schemas/ApplicantImportCompletedRequest1' responses: '200': description: OK deprecated: false /resources/applicants/-/applicantImport: post: tags: - Applicant summary: Import applicant with images by archive operationId: Applicant_importByArchive description: Imports applicant data and images including associated review results. parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplicantImportByArchiveRequest' multipart/form-data: schema: $ref: '#/components/schemas/ApplicantImportByArchiveRequest1' responses: '200': description: OK deprecated: false /resources/applicants/{applicantId}/status/testCompleted: post: tags: - Applicant summary: Set review for applicant in sandbox operationId: Applicant_sandboxVerificationResponse description: Simulates a verification reposnose. parameters: - description: A unique applicant identifier. name: applicantId in: path schema: type: string required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplicantSandboxVerificationResponseRequest' multipart/form-data: schema: $ref: >- #/components/schemas/ApplicantSandboxVerificationResponseRequest1 responses: '200': description: OK deprecated: false x-readme: code-samples: - language: curl code: |- curl -X POST \ 'https://api.sumsub.com/resources/applicants/5bb8cca10a975a624903cf65/status/testCompleted' \ -H 'content-type: application/json' \ -d '{ "reviewAnswer": "RED", "moderationComment": "We do not accept screenshots. Please upload an original photo.", "clientComment": "Screenshots are not accepted.", "reviewRejectType": "RETRY", "rejectLabels": ["UNSATISFACTORY_PHOTOS","SCREENSHOTS"] } ' samples-languages: - curl /resources/applicants/{applicantId}/tags/add: post: tags: - Applicant summary: Add custom applicant tags operationId: Applicant_addCustomTags description: Adds custom tags to applicant profiles. parameters: - description: A unique applicant identifier. name: applicantId in: path schema: type: string required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplicantAddCustomTagsRequest' multipart/form-data: schema: $ref: '#/components/schemas/ApplicantAddCustomTagsRequest1' responses: '200': description: OK deprecated: false /resources/applicants/{applicantId}/tags: post: tags: - Applicant summary: Add and overwrite custom applicant tags operationId: Applicant_addCustomTags description: Adds and overwrites custom tags in applicant profiles. parameters: - description: A unique applicant identifier. name: applicantId in: path schema: type: string required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplicantAddCustomTagsRequest2' multipart/form-data: schema: $ref: '#/components/schemas/ApplicantAddCustomTagsRequest3' responses: '200': description: OK deprecated: false x-readme: code-samples: - language: curl code: > curl -X POST 'https://api.sumsub.com/resources/applicants/5fd1012c885b5d0009d50e6e/tags' \ -H 'Content-Type: application/json' \ -d '["Approved Sanctions", "Approved PEP", "821"]' samples-languages: - curl delete: tags: - Applicant summary: Remove custom applicant tags operationId: Applicant_removeCustomTags description: Removes all custom tags from applicant profiles. parameters: - description: A unique applicant identifier. name: applicantId in: path schema: type: string required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplicantRemoveCustomTagsRequest' multipart/form-data: schema: $ref: '#/components/schemas/ApplicantRemoveCustomTagsRequest1' responses: '200': description: OK deprecated: false /resources/applicants/{applicantId}/status/pending?reason={reason}: post: tags: - Applicant summary: Request applicant check operationId: Applicant_initiateApplicantCheck description: Initiates a check of the applicant profile. parameters: - description: A note indicating the reason for checking the applicant profile. name: reason in: query schema: type: string - description: A unique applicant identifier. name: applicantId in: path schema: type: string required: true responses: '200': description: OK deprecated: false /resources/applicants/{applicantId}/blacklist?note={note}: post: tags: - Applicant summary: Add applicant to blocklist operationId: Applicant_addToBlocklist description: Add an applicant to blocklist. parameters: - description: A note indicating the reason for blocklisting the applicant profile. name: note in: query required: true schema: type: string - description: A unique applicant identifier. name: applicantId in: path schema: type: string required: true responses: '200': description: OK deprecated: false /resources/applicants/{applicantId}/reset: post: tags: - Applicant summary: Reset applicant profile operationId: Applicant_resetProfile description: >- Marks documents uploaded by the applicant as inactive and deletes all statuses assigned earlier. parameters: - description: A unique applicant identifier. name: applicantId in: path schema: type: string required: true responses: '200': description: OK deprecated: false /resources/applicants/{applicantId}/resetStep/{idDocSetType}: post: tags: - Applicant summary: Reset verification step operationId: Applicant_resetVerificationStep description: Resets the specified verification step. parameters: - description: A unique applicant identifier. name: applicantId in: path schema: type: string required: true - description: >- A [step name](ref:reset-single-verification-step#available-steps-to-reset) to reset. name: idDocSetType in: path schema: type: string required: true responses: '200': description: OK deprecated: false /resources/inspections/{inspectionId}/resources/{imageId}: delete: tags: - Image summary: Mark image as inactive operationId: Image_markAsInactive description: Marks uploaded images as deleted. parameters: - description: Set `true` to revert inactivity of the image. name: revert in: query schema: type: boolean default: false - description: >- An inspection identifier. You can get this number by using [this API method](ref:get-applicant-data). name: inspectionId in: path schema: type: string required: true - description: >- An image identifier. You can get this number by using [this API method](ref:get-applicant-verification-steps-status). name: imageId in: path schema: type: string required: true responses: '200': description: OK deprecated: false get: tags: - Image summary: Get document images operationId: Image_getDocumentImages description: Returns document images. parameters: - description: >- An inspection identifier. This identifier is returned as a root field upon running [this API method](ref:get-applicant-data). name: inspectionId in: path schema: type: string required: true - description: >- An image identifier. You can get this number by using [this API method](ref:get-applicant-verification-steps-status). name: imageId in: path schema: type: string required: true responses: '200': description: OK deprecated: false /resources/applicants/{applicantId}/presence/{status}: patch: tags: - Applicant summary: Deactivate applicant profile operationId: Applicant_deactivateProfile description: Deactivates an applicant profile. parameters: - description: A unique applicant identifier. name: applicantId in: path schema: type: string required: true - description: >- Possible values: `deactivated` to deactivate the applicant profile. `activated` to reactivate the applicant profile. name: status in: path schema: type: string required: true responses: '200': description: OK deprecated: false /resources/applicants/{applicantId}/agreement: post: tags: - Applicant summary: Add applicant consent operationId: Applicant_addConsentToProfile description: Adds a consent to the applicant profile. parameters: - description: >- A unique identifier of an applicant profile to which a consent should be added. name: applicantId in: path schema: type: string required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplicantAddConsentToProfileRequest' multipart/form-data: schema: $ref: '#/components/schemas/ApplicantAddConsentToProfileRequest1' responses: '200': description: OK deprecated: false /resources/applicants/{applicantId}/one: get: tags: - Applicant summary: Get applicant data operationId: Applicant_getData description: Returns applicant information. parameters: - description: A unique applicant identifier name: applicantId in: path schema: type: string required: true responses: '200': description: '200' content: application/json: examples: Individual applicants: value: |- { "id": "5b594ade0a975a36c9349e66", "createdAt": "2020-06-24 05:05:14", "clientId": "ClientName", "inspectionId": "5b594ade0a975a36c9379e67", "externalUserId": "SomeExternalUserId", "fixedInfo": { "firstName": "Chris", "lastName": "Smith" }, "info": { "firstName": "CHRISTIAN", "firstNameEn": "CHRISTIAN", "lastName": "SMITH", "lastNameEn": "SMITH", "dob": "1989-07-16", "country": "DEU", "idDocs": [ { "idDocType": "ID_CARD", "country": "DEU", "firstName": "CHRISTIAN", "firstNameEn": "CHRISTIAN", "lastName": "SMITH", "lastNameEn": "SMITH", "validUntil": "2028-09-04", "number": "LGXX359T8", "dob": "1989-07-16", "mrzLine1": "IDD<- Returns information about the documents or separate verification step results. The method works both for individuals and company applicants. parameters: - description: A unique applicant identifier. name: applicantId in: path schema: type: string required: true responses: '200': description: OK deprecated: false /resources/moderationStates/-;applicantId={applicantId}: get: tags: - Applicant summary: Clarify rejection reason operationId: Applicant_clarifyRejectionReason description: Returns rejection reason clarification. parameters: - description: A unique applicant identifier. name: applicantId in: path schema: type: string required: true responses: '200': description: OK deprecated: false /resources/checks/latest?type=TIN: get: tags: - Check summary: Get TIN (SSN) check results operationId: Check_tinSsnCheckResults description: Returns TIN (SSN) check results. parameters: - description: A unique applicant identification number. name: applicantId in: query required: true schema: type: string responses: '200': description: OK deprecated: false /resources/checks/latest?type=EMAIL_CONFIRMATION: get: tags: - Check summary: Get email confirmation check results operationId: Check_emailConfirmationResults description: Returns email confirmation check results. parameters: - description: A unique applicant identifier. name: applicantId in: query required: true schema: type: string responses: '200': description: OK deprecated: false /resources/checks/latest?type=PHONE_CONFIRMATION: get: tags: - Check summary: Get phone confirmation check results operationId: Check_phoneConfirmationResults description: Returns phone confirmation check results. parameters: - description: A unique applicant identifier. name: applicantId in: query required: true schema: type: string responses: '200': description: OK deprecated: false /resources/checks/latest?type=IP_CHECK: get: tags: - Check summary: Get IP check results operationId: Check_ipCheckResults description: Returns IP check results. parameters: - description: A unique applicant identifier. name: applicantId in: query required: true schema: type: string responses: '200': description: OK deprecated: false /resources/applicantFraudNetworks/-/byApplicant/{applicantId}: get: tags: - Applicant summary: Get applicant fraud networks operationId: Applicant_getFraudNetworksByApplicant description: Returns all fraud networks by `applicantId`. parameters: - description: A unique applicant identifier. name: applicantId in: path schema: type: string required: true responses: '200': description: OK deprecated: false /resources/applicantFraudNetworks/{networkId}/one: get: tags: - Applicant summary: Get fraud network by ID operationId: Applicant_getFraudNetworkById description: Returns fraud network by `networkId`. parameters: - description: A unique network identifier. name: networkId in: path schema: type: string required: true responses: '200': description: OK deprecated: false /resources/inspections/{inspectionId}?fields=videoIdentData: get: tags: - Inspection summary: Get video call data operationId: Inspection_getVideoIdentData description: Returns the video call results. parameters: - description: A unique inspection identifier. name: inspectionId in: path schema: type: string required: true responses: '200': description: OK deprecated: false /resources/videoIdent/applicant/{applicantId}/media/{compositionMediaId}: get: tags: - Applicant summary: Get video call media operationId: Applicant_getVideoCallMedia description: Returns video call media. parameters: - description: A unique applicant identifier. name: applicantId in: path schema: type: string required: true - description: Video call media identifier. name: compositionMediaId in: path schema: type: string required: true responses: '200': description: OK deprecated: false /resources/sdkIntegrations/levels/{levelName}/websdkLink: post: tags: - WebSDKLink summary: Generate external WebSDK link operationId: WebSdkLink_generateExternal description: Creates a link to WebSDK for the specified applicant. parameters: - description: A lifespan of the link in seconds. name: ttlInSecs in: query schema: type: integer format: int32 - description: An external user ID on your side. name: externalUserId in: query schema: type: string - description: The language for WebSDK in ISO 639-1 format. name: lang in: query schema: type: string - description: >- A [verification level](https://docs.sumsub.com/reference) 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. name: levelName in: path schema: type: string required: true responses: '200': description: OK deprecated: false x-readme: code-samples: - language: curl code: | curl -X POST \ 'https://api.sumsub.com/resources/sdkIntegrations/levels/basic-kyc-level/websdkLink?ttlInSecs=1800&externalUserId=304775ty&lang=en' \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -d '{ }' samples-languages: - curl /resources/applicants/-/levels: get: tags: - Applicant summary: Get available applicant levels operationId: Applicant_getLevels description: Returns a list of verification levels. responses: '200': description: OK deprecated: false /resources/checks/latest?type=POA: get: tags: - Check summary: Get additional PoA data operationId: Check_additionalPoaData description: Returns PoA data. parameters: - description: A unique applicant identifier. name: applicantId in: query required: true schema: type: string responses: '200': description: OK deprecated: false /resources/accessTokens: post: tags: - Token summary: Generate access token operationId: Token_createActionToken description: Creates an applicant action token. parameters: - description: A lifespan of a token in seconds. Default value is 10 mins. name: ttlInSecs in: query schema: type: string default: '600' - description: An external user ID which will be bound to the token. name: userId in: query required: true schema: type: string - description: An external action ID which will be bound to the token. name: externalActionId in: query required: true schema: type: string - description: >- The name of the [verification level](https://docs.sumsub.com/reference). name: levelName in: query required: true schema: type: string responses: '200': description: OK deprecated: false /resources/applicantActions/-;applicantId={applicantId}: get: tags: - Applicant summary: Get applicant actions operationId: Applicant_getActions description: Returns the list of applicant actions. parameters: - description: Limit of applicant actions to be returned. name: limit in: query schema: type: integer format: int32 default: 1000 - description: Offset of applicant actions to be returned. name: offset in: query schema: type: integer format: int32 default: 0 - description: A unique applicant identifier. name: applicantId in: path schema: type: string required: true responses: '200': description: OK deprecated: false /resources/applicantActions/{actionId}/one: get: tags: - Applicant summary: Get action information operationId: Applicant_getActionOneInfo description: Returns information about the applicant action checks. parameters: - description: A unique applicant action identifier. name: actionId in: path schema: type: string required: true responses: '200': description: OK deprecated: false /resources/applicantActions/-/forApplicant/{applicantId}?levelName={levelName}: post: tags: - Applicant summary: Create applicant action operationId: Applicant_createAction description: Creates an applicant action. parameters: - description: A unique aplicant identifier. name: applicantId in: path schema: type: string required: true - description: A name of the level configured in the dashboard. name: levelName in: query required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplicantCreateActionRequest' multipart/form-data: schema: $ref: '#/components/schemas/ApplicantCreateActionRequest1' responses: '200': description: OK deprecated: false /resources/applicantActions/-/forApplicant/{applicantId}/?levelName=paymentSource: post: tags: - Applicant summary: Create payment source actions operationId: Applicant_createPaymentSourceActions description: >- Creates an action to process a payment source and to confirm the owner of the payment method. parameters: - description: An unique applicant identifier. name: applicantId in: path schema: type: string required: true - description: >- A verification level name for which you want to create a payment source action. name: levelName in: query required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplicantCreatePaymentSourceActionsRequest' multipart/form-data: schema: $ref: '#/components/schemas/ApplicantCreatePaymentSourceActionsRequest1' responses: '200': description: '200' content: text/plain: examples: Result: value: |- { "id": "65e9624496bed30142a6d15c", "createdAt": "2024-03-07 06:44:24", "key": "SBCJVLAAMRHYAB", "clientId": "client_id", "externalActionId": "payment-source-1fbH9AYHn", "applicantId": "65e881a212b4ef468def3bbb", "review": { "reviewId": "RlWfu", "attemptId": "dhABq", "attemptCnt": 0, "levelName": "paymentSource", "createDate": "2024-03-07 06:44:24+0000", "reviewStatus": "init" }, "requiredIdDocs": { "docSets": [ { "idDocSetType": "PAYMENT_METHODS", "types": [ "PAYMENT_SOURCE" ] } ] }, "paymentSource": { "id": "c4032de1-2e1c-4b29-8a81-623103f9cd51", "createdAt": "2024-03-07 06:44:24", "fixedInfo": { "institutionName": "Name", "fullName": "John Doe", "accountIdentifier": "120834387", "email": "JohnDoe@mail.com", "type": "paymentMethod" } } } schema: $ref: >- #/components/schemas/ApplicantCreatePaymentSourceActionsResponse deprecated: false /resources/applicantActions/{actionId}/review/status/pending: post: tags: - Applicant summary: Request action check operationId: Applicant_requestActionCheck description: Requests an applicant action check. parameters: - description: A unique applicant action identifier. name: actionId in: path schema: type: string required: true responses: '200': description: OK deprecated: false x-readme: code-samples: - language: curl code: |2 curl -X POST \ 'https://api.sumsub.com/resources/applicantActions/5e022e0f0a975a45325c7ff5/review/status/pending' samples-languages: - curl /resources/applicantActions/-/forApplicant/{applicantId}/paymentMethod: post: tags: - Applicant summary: Submit payment method operationId: Applicant_submitPaymentMethod description: Submits a payment method. parameters: - description: >- Use `externalActionId` if you intend to [initialize SDK](ref:about-applicant-actions) for that particular action. name: X-External-Action-Id in: header required: true schema: type: string - description: Sets the video selfie at `requiredIdDocs` for the action. name: requireSelfie in: query schema: type: boolean default: false - description: A unique applicant identifier. name: applicantId in: path schema: type: string required: true responses: '200': description: OK deprecated: false /resources/applicantActions/{actionId}/paymentMethod: post: tags: - Applicant summary: Add payment method information operationId: Applicant_addPaymentMethodInformation description: Adds additional information to the payment method. parameters: - description: A unique applicant action identifier. name: actionId in: path schema: type: string required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplicantAddPaymentMethodInformationRequest' multipart/form-data: schema: $ref: >- #/components/schemas/ApplicantAddPaymentMethodInformationRequest1 responses: '200': description: OK deprecated: false /resources/applicantActions/{actionId}/images/{imageId}?preview={isPreview}: get: tags: - Applicant summary: Get bank card image operationId: Applicant_getBankCardImage description: Returns an original bank card image. parameters: - description: Indicates if an image thumbnail should be returned. name: isPreview in: query schema: type: boolean default: false - description: A unique applicant action identifier. name: actionId in: path schema: type: string required: true - description: An image identifier taken from `images[].imageId`. name: imageId in: path schema: type: string required: true responses: '200': description: OK deprecated: false /resources/applicantActions/{actionId}/images: post: tags: - Applicant summary: Add image to payment method operationId: Applicant_addImageToPaymentMethod description: Adds an image to the payment method. parameters: - description: A unique applicant action identifier. name: actionId in: path schema: type: string required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplicantAddImageToPaymentMethodRequest' multipart/form-data: schema: $ref: '#/components/schemas/ApplicantAddImageToPaymentMethodRequest1' responses: '200': description: OK deprecated: false /resources/applicantActions/-/forApplicant/{applicantId}/cryptoSourceOfFunds: post: tags: - Applicant summary: Submission operationId: Applicant_createCryptoSourceOfFunds description: Creates an action with transaction information. parameters: - description: A unique applicant identifier. name: applicantId in: path schema: type: string required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplicantCreateCryptoSourceOfFundsRequest' multipart/form-data: schema: $ref: '#/components/schemas/ApplicantCreateCryptoSourceOfFundsRequest1' responses: '200': description: OK deprecated: false /resources/standalone/crypto/cryptoSourceOfFunds: post: tags: - Analysis summary: Standalone crypto analysis operationId: Analysis_standaloneCryptoInitiation description: Initiates standalone crypto analysis. requestBody: content: application/json: schema: $ref: '#/components/schemas/AnalysisStandaloneCryptoInitiationRequest' multipart/form-data: schema: $ref: '#/components/schemas/AnalysisStandaloneCryptoInitiationRequest1' responses: '200': description: OK deprecated: false /resources/standalone/crypto/availableCurrencies: get: tags: - Token summary: Get available tokens operationId: Token_getAvailableCurrencies description: Returns available tokens. responses: '200': description: OK deprecated: false /resources/applicants/{applicantId}/info/companyInfo/beneficiaries: post: tags: - Applicant summary: Add applicant as beneficiary operationId: Applicant_addBeneficiary description: Adds an existing individual applicant as a beneficiary. parameters: - description: A unique company applicant identifier. name: applicantId in: path schema: type: string required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplicantAddBeneficiaryRequest' multipart/form-data: schema: $ref: '#/components/schemas/ApplicantAddBeneficiaryRequest1' responses: '200': description: OK deprecated: false /resources/applicants/{applicantId}/info/companyInfo/beneficiaries/{beneficiaryApplicantId}: delete: tags: - Applicant summary: Remove applicant from beneficiary list operationId: Applicant_removeFromBeneficiaryList description: Removes the applicant from the list of company beneficial owners. parameters: - description: A unique company applicant identifier. name: applicantId in: path schema: type: string required: true - description: Beneficiary applicant identifier. name: beneficiaryApplicantId in: path schema: type: string required: true responses: '200': description: OK deprecated: false /resources/applicants/{applicantId}/info/companyInfo: patch: tags: - Applicant summary: Change company data operationId: Applicant_changeCompanyData description: Changes the company data. parameters: - description: A unique applicant identifier. name: applicantId in: path schema: type: string required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplicantChangeCompanyDataRequest' multipart/form-data: schema: $ref: '#/components/schemas/ApplicantChangeCompanyDataRequest1' responses: '200': description: OK deprecated: false /resources/checks/latest?type=COMPANY: get: tags: - Check summary: Get additional company check data operationId: Check_additionalCompanyData description: Returns company check results. parameters: - description: A unique applicant identifier. name: applicantId in: query required: true schema: type: string responses: '200': description: OK deprecated: false /resources/applicants/{applicantId}/ekyc/submit (COPY): post: tags: - Verification summary: Submit applicant data for non-doc verification operationId: Verification_submitApplicantData description: Submits the applicant data for Non-Doc Verification. parameters: - description: A unique applicant identifier. name: applicantId in: path schema: type: string required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/VerificationSubmitApplicantDataRequest' multipart/form-data: schema: $ref: '#/components/schemas/VerificationSubmitApplicantDataRequest1' responses: '200': description: OK deprecated: false /resources/applicants/{applicantId}/ekyc/confirm/{confirmationid}: post: tags: - Applicant summary: Confirm applicant data for non-doc verification operationId: Applicant_confirmData description: Confirms the applicant data with the `otp` code or via `oAuth`. parameters: - description: A unique applicant identifier. name: applicantId in: path schema: type: string required: true - description: >- A confirmation identifier from the [submission](ref:submit-applicant-data) response. name: confirmationId in: path schema: type: string required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplicantConfirmDataRequest' multipart/form-data: schema: $ref: '#/components/schemas/ApplicantConfirmDataRequest1' responses: '200': description: OK deprecated: false /resources/checks/latest: get: tags: - Applicant summary: Get non-doc verification applicant data operationId: Applicant_getDataLatest description: Returns the applicant data for Non-Doc Verification. parameters: - description: Check type. name: type in: query required: true schema: type: string enum: - E_KYC_CHECK - RESIDENCY_CHECK - description: A unique applicant identifier. name: applicantId in: query required: true schema: type: string responses: '200': description: OK deprecated: false /resources/applicants/{applicantId}/kyt/txns/-/data: post: tags: - Applicant summary: Submit transaction for existing applicant operationId: Applicant_submitTransactionData description: Initiates transaction processing. parameters: - description: >- 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](ref:submit-transaction-for-non-existing-applicant) instead. name: applicantId in: path schema: type: string required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplicantSubmitTransactionDataRequest' multipart/form-data: schema: $ref: '#/components/schemas/ApplicantSubmitTransactionDataRequest1' responses: '200': description: OK deprecated: false /resources/applicants/-/kyt/txns/-/data: post: tags: - Applicant summary: Submit transaction for non-existing applicant operationId: Applicant_submitTransactionForNonExisting description: Initiates transaction processing for non-existing applicants. parameters: - description: >- A [verification level](https://docs.sumsub.com/reference) 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. name: levelName in: query required: true schema: type: string requestBody: content: application/json: schema: $ref: >- #/components/schemas/ApplicantSubmitTransactionForNonExistingRequest multipart/form-data: schema: $ref: >- #/components/schemas/ApplicantSubmitTransactionForNonExistingRequest1 responses: '200': description: OK deprecated: false /resources/kyt/txns/{id}/one: get: tags: - Transaction summary: Get transaction information operationId: Transaction_informationOne description: Returns transaction information. parameters: - description: A unique transaction identifier. name: id in: path schema: type: string required: true responses: '200': description: OK deprecated: false /resources/kyt/txns/-;data.txnId={externalTxnId}/one: get: tags: - Transaction summary: Get transaction information (externalTxnId) operationId: Transaction_getOneData description: Returns transaction information based on the provided `externalTxnId`. parameters: - description: A unique transaction identifier on your side. name: externalTxnId in: path schema: type: string required: true responses: '200': description: OK deprecated: false /resources/kyt/misc/txns/import: post: tags: - Transaction summary: Bulk transaction import operationId: Transaction_bulkImport description: Imports a list of transactions. parameters: - description: >- name: ignoreErrors in: query schema: type: boolean default: false - description: >- Allows you to control whether scoring should be run on imported transactions or not: name: scoreSavedTxns in: query schema: type: boolean default: true requestBody: content: application/json: schema: $ref: '#/components/schemas/TransactionBulkImportRequest' multipart/form-data: schema: $ref: '#/components/schemas/TransactionBulkImportRequest1' responses: '200': description: OK deprecated: false /resources/kyt/txns/{id}/props: patch: tags: - Transaction summary: Change transaction properties operationId: Transaction_updateProperties description: Updates transaction properties. parameters: - description: >- A list of property names separated by commas that should be set to `null`. name: unsetKeys in: query schema: type: string - description: A unique transaction identification number. name: id in: path schema: type: string required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/TransactionUpdatePropertiesRequest' multipart/form-data: schema: $ref: '#/components/schemas/TransactionUpdatePropertiesRequest1' responses: '200': description: OK deprecated: false /resources/kyt/txns/{id}/-/score: post: tags: - Transaction summary: Re-score transaction operationId: Transaction_reScore description: Re-scores transactions. parameters: - description: A unique transaction identification number. name: id in: path schema: type: string required: true responses: '200': description: OK deprecated: false /resources/kyt/txns/{id}/review/status/completed: post: tags: - Transaction summary: Approve and reject transaction operationId: Transaction_approveReject description: Approves or rejects transactions. parameters: - description: A unique transaction identification number. name: id in: path schema: type: string required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/TransactionApproveRejectRequest' multipart/form-data: schema: $ref: '#/components/schemas/TransactionApproveRejectRequest1' responses: '200': description: OK deprecated: false /resources/kyt/txns/{id}/tags: get: tags: - Transaction summary: Get tags operationId: Transaction_listTags description: Returns a list of transaction tags. parameters: - description: A unique transaction identifier. name: id in: path schema: type: string required: true responses: '200': description: OK deprecated: false post: tags: - Tag summary: Add tags operationId: Tag_addTransactionTags description: Adds tags to transactions. parameters: - description: A unique transaction identifier. name: id in: path schema: type: string required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/TagAddTransactionTagsRequest' multipart/form-data: schema: $ref: '#/components/schemas/TagAddTransactionTagsRequest1' responses: '200': description: OK deprecated: false delete: tags: - Transaction summary: Remove tags operationId: Transaction_removeTags description: Removes tags from transactions. parameters: - description: A unique transaction identifier. name: id in: path schema: type: string required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/TransactionRemoveTagsRequest' multipart/form-data: schema: $ref: '#/components/schemas/TransactionRemoveTagsRequest1' responses: '200': description: OK deprecated: false /resources/kyt/txns/{id}/notes: get: tags: - Note summary: Get notes operationId: Note_getTransactionNotes description: Returns transaction notes. parameters: - description: A unique transaction identifier. name: id in: path schema: type: string required: true responses: '200': description: OK deprecated: false /resources/kyt/txns/notes: post: tags: - Note summary: Add notes operationId: Note_addToTransaction description: Adds notes to transactions. requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteAddToTransactionRequest' multipart/form-data: schema: $ref: '#/components/schemas/NoteAddToTransactionRequest1' responses: '200': description: OK deprecated: false patch: tags: - Note summary: Edit notes operationId: Note_updateTransactionNotes description: Updates a note. requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteUpdateTransactionNotesRequest' multipart/form-data: schema: $ref: '#/components/schemas/NoteUpdateTransactionNotesRequest1' responses: '200': description: OK deprecated: false delete: tags: - Note summary: Remove notes operationId: Note_removeFromTransaction description: Removes notes from transactions. requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteRemoveFromTransactionRequest' multipart/form-data: schema: $ref: '#/components/schemas/NoteRemoveFromTransactionRequest1' responses: '200': description: OK deprecated: false /resources/kyt/txns/{txnId}/data/info: patch: tags: - Transaction summary: Patch transaction with chain transaction ID operationId: Transaction_updateBlockchainInfo description: Updates information from the blockchain. parameters: - description: A unique transaction identifier. name: txnId in: path schema: type: string required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/TransactionUpdateBlockchainInfoRequest' multipart/form-data: schema: $ref: '#/components/schemas/TransactionUpdateBlockchainInfoRequest1' responses: '200': description: '200' content: application/json: examples: Result: value: '{}' schema: $ref: '#/components/schemas/TransactionUpdateBlockchainInfoResponse' deprecated: false x-readme: code-samples: - language: curl code: | curl -X PATCH \ 'https://api.sumsub.com/resources/kyt/txns/638f1e3656df2d000138bff0/data/info' \ -H 'Content-Type: application/json' \ -d '{ "fingerprint": "1328d8738e244eaedfc6172a1038d5c52a689ca7631ece90d7aa1742e59048a2" }' samples-languages: - curl /resources/kyt/txns/{txnId}/applicantId/{applicantId}: post: tags: - Applicant summary: Move transaction to another applicant operationId: Applicant_moveTransactionToAnotherApplicant description: Moves transaction to the specified applicant. parameters: - description: A unique transaction identifier. name: txnId in: path schema: type: string required: true - description: A unique applicant identifier who should own the transaction. name: applicantId in: path schema: type: string required: true responses: '200': description: '200' content: application/json: examples: Result: value: '{}' schema: $ref: >- #/components/schemas/ApplicantMoveTransactionToAnotherApplicantResponse deprecated: false x-readme: code-samples: - language: curl code: | curl -X POST \ 'https://api.sumsub.com/resources/kyt/txns/631f268442d8290001e1eee8/applicantId/631f268442d8290001e1eee9' samples-languages: - curl /resources/kyt/txns/{txnId}/data/applicant: patch: tags: - Applicant summary: Enriching transaction with Travel Rule operationId: Applicant_enrichTransactionWithTravelRuleData description: Enriches transaction with the Travel Rule data. parameters: - description: A unique transaction identifier. name: txnId in: path schema: type: string required: true requestBody: content: application/json: schema: $ref: >- #/components/schemas/ApplicantEnrichTransactionWithTravelRuleDataRequest multipart/form-data: schema: $ref: >- #/components/schemas/ApplicantEnrichTransactionWithTravelRuleDataRequest1 responses: '200': description: '200' content: application/json: examples: Result: value: '{}' schema: $ref: >- #/components/schemas/ApplicantEnrichTransactionWithTravelRuleDataResponse deprecated: false x-readme: code-samples: - language: curl code: | curl -X PATCH \ 'https://api.sumsub.com/resources/kyt/txns/638f1e3656df2d000138bff0/data/applicant' \ -H 'Content-Type: application/json' \ -d '{ "fullName": "John Snow" }' samples-languages: - curl /resources/kyt/txns/{txnId}/ownership/confirmed: post: tags: - Transaction summary: Confirm transaction ownership operationId: Transaction_confirmOwnership description: Confirms that the specified transaction belongs to your exchange (VASP). parameters: - description: A unique transaction identifier. name: txnId in: path schema: type: string required: true responses: '200': description: OK deprecated: false /resources/kyt/txns/{txnId}/ownership/unconfirmed: post: tags: - Transaction summary: Remove transaction ownership operationId: Transaction_removeOwnership description: Removes the ownership from a previously confirmed transaction. parameters: - description: A unique transaction identifier. name: txnId in: path schema: type: string required: true responses: '200': description: OK deprecated: false /resources/vasps/-: get: tags: - VASP summary: Get available VASPs operationId: Vasp_getAvailableVasps description: Returns a list of VASPs from the Sumsub VASP directory. parameters: - description: >- Maximum number of the VASPs to be returned. The maximum recommended value you can set is 100. name: limit in: query schema: type: integer format: int32 default: 10 - description: Offset of the VASPs to be returned. name: offset in: query schema: type: integer format: int32 default: 0 responses: '200': description: '200' content: application/json: examples: Result: value: '{}' schema: $ref: '#/components/schemas/VaspGetAvailableVaspsResponse' '400': description: '400' content: application/json: examples: Result: value: '{}' schema: $ref: '#/components/schemas/VaspGetAvailableVasps400Response' deprecated: false /resources/accessTokens/behavior: post: tags: - AccessToken summary: Generate access token operationId: AccessToken_generateFishermanToken description: >- Creates an access token to apply [Fisherman](ref:about-fisherman) per applicant session. requestBody: content: application/json: schema: $ref: '#/components/schemas/AccessTokenGenerateFishermanTokenRequest' multipart/form-data: schema: $ref: '#/components/schemas/AccessTokenGenerateFishermanTokenRequest1' responses: '200': description: OK deprecated: false /resources/applicants/-/kyt/txns/-/data?accessToken={accessToken}: post: tags: - AccessToken summary: Confirm applicant platform event operationId: AccessToken_confirmPlatformEvent description: Confirms that the platform event on the applicant side is completed. parameters: - description: >- Access token that you have [received at the first step](ref:generate-access-token-fisherman) of the flow. name: accessToken in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccessTokenConfirmPlatformEventRequest' multipart/form-data: schema: $ref: '#/components/schemas/AccessTokenConfirmPlatformEventRequest1' responses: '200': description: OK deprecated: false /resources/auditTrailEvents: get: tags: - AuditTrailEvent summary: Audit trail events operationId: AuditTrailEvent_getEvents description: Returns audit trail events. parameters: - description: >- The name of the subject for which events are received. If the name is not specified, the events are received for all subjects on the key. name: subjectName in: query schema: type: string - description: >- If specified, only the events with this activity will be in the response. name: activity in: query schema: type: string - description: >- Date/time events are received from (`yyyy-MM-dd HH:mm:ss`, e.g. 2022-10-01 12:05:00). If not specified, the events are received from the day before. name: from in: query schema: type: string - description: >- To the date/time events are received (`yyyy-MM-dd HH:mm:ss`, e.g. 2022-10-01 12:15:00). If not specified, the events are received up to the present moment. name: to in: query schema: type: string - description: >- The maximum number of events per request. Cannot be more than 20000. By default is 10. name: limit in: query schema: type: string default: '10' - description: >- Allows to skip the offset events before beginning to return the events. By default is 0. name: offset in: query schema: type: string default: '0' responses: '200': description: OK deprecated: false /resources/applicantFraudNetworks: get: tags: - Applicant summary: Get fraud networks operationId: Applicant_getFraudNetworks description: Returns fraud networks. parameters: - description: Offset of the found networks to be returned. name: offset in: query schema: type: integer format: int32 default: 0 - description: >- Maximum number of the found networks to be returned. The maximum value you can set is 100. name: limit in: query schema: type: integer format: int32 default: 10 responses: '200': description: OK deprecated: false components: securitySchemes: sec0: type: apiKey in: header name: X-App-Token x-default: '' schemas: ApplicantUpdateTopLevelInfoRequest: type: object required: - id properties: id: description: A unique applicant identifier. type: string externalUserId: description: An external applicant identifier. type: string email: description: A new email address that you want to assign to the given applicant. type: string phone: description: A new phone number that you want to assign to the given applicant. type: string sourceKey: description: >- A new [source key](https://docs.sumsub.com/reference) that you want to assign to the given applicant. type: string lang: description: >- The language, in which the applicant should see the verification results. type: string questionnaires: description: >- A [questionnaire](https://docs.sumsub.com/reference) configuration with the answers. type: array items: description: >- WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema. metadata: description: Additional information about the applicant. type: array items: description: >- WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema. deleted: description: Marks the applicant profile as inactive. type: boolean ApplicantUpdateTopLevelInfoRequest1: type: object required: - id properties: id: description: A unique applicant identifier. type: string externalUserId: description: An external applicant identifier. type: string email: description: A new email address that you want to assign to the given applicant. type: string phone: description: A new phone number that you want to assign to the given applicant. type: string sourceKey: description: >- A new [source key](https://docs.sumsub.com/reference) that you want to assign to the given applicant. type: string lang: description: >- The language, in which the applicant should see the verification results. type: string questionnaires: description: >- A [questionnaire](https://docs.sumsub.com/reference) configuration with the answers. type: array items: description: >- WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema. metadata: description: Additional information about the applicant. type: array items: description: >- WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema. deleted: description: Marks the applicant profile as inactive. type: boolean ApplicantAddIdDocumentRequest: type: object properties: metadata: description: An object that represents an ID document. type: object required: - idDocType - country properties: idDocType: description: A document type. type: string idDocSubType: description: '`FRONT_SIDE`, `BACK_SIDE` or `null`.' type: string country: description: ISO 3166-1 alpha-3 country code. type: string firstName: description: First applicant name. type: string middleName: description: Middle applicant name. type: string lastName: description: Last applicant name. type: string issuedDate: description: Issued date (format `YYYY-mm-dd`, e.g. 2001-09-25). type: string validUntil: description: Valid until date (format `YYYY-mm-dd`, e.g. 2001-09-26). type: string number: description: A document number. type: string dob: description: Applicant date of birth. type: string placeOfBirth: description: Applicant birthplace. type: string content: description: A photo of the document. type: string format: binary ApplicantAddIdDocumentRequest1: type: object properties: metadata: description: An object that represents an ID document. type: object required: - idDocType - country properties: idDocType: description: A document type. type: string idDocSubType: description: '`FRONT_SIDE`, `BACK_SIDE` or `null`.' type: string country: description: ISO 3166-1 alpha-3 country code. type: string firstName: description: First applicant name. type: string middleName: description: Middle applicant name. type: string lastName: description: Last applicant name. type: string issuedDate: description: Issued date (format `YYYY-mm-dd`, e.g. 2001-09-25). type: string validUntil: description: Valid until date (format `YYYY-mm-dd`, e.g. 2001-09-26). type: string number: description: A document number. type: string dob: description: Applicant date of birth. type: string placeOfBirth: description: Applicant birthplace. type: string content: description: A photo of the document. type: string format: binary ApplicantUpdateFixedInfoRequest: type: object properties: firstName: description: The first name of the applicant. type: string lastName: description: The last name of the applicant. type: string middleName: description: The middle name of the applicant. type: string firstNameEn: description: Automatic transliteration of the first name. type: string lastNameEn: description: Automatic transliteration of the last name. type: string middleNameEn: description: Automatic transliteration of the middle name. type: string legalName: description: Legal name. type: string gender: description: An applicant gender (`M` or `F`). type: string dob: description: Applicant date of birth (format `YYYY-mm-dd`, e.g. 2001-09-25). type: string placeOfBirth: description: The applicant birthplace. type: string countryOfBirth: description: Applicant country of birth. type: string stateOfBirth: description: Applicant state of birth. type: string country: description: Alpha-3 country code (e.g. `DEU` or `GBR`). type: string nationality: description: Alpha-3 country code. type: string addresses: description: List of applicant addresses. type: array items: description: >- WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema. tin: description: Tax identification number. type: string ApplicantUpdateFixedInfoRequest1: type: object properties: firstName: description: The first name of the applicant. type: string lastName: description: The last name of the applicant. type: string middleName: description: The middle name of the applicant. type: string firstNameEn: description: Automatic transliteration of the first name. type: string lastNameEn: description: Automatic transliteration of the last name. type: string middleNameEn: description: Automatic transliteration of the middle name. type: string legalName: description: Legal name. type: string gender: description: An applicant gender (`M` or `F`). type: string dob: description: Applicant date of birth (format `YYYY-mm-dd`, e.g. 2001-09-25). type: string placeOfBirth: description: The applicant birthplace. type: string countryOfBirth: description: Applicant country of birth. type: string stateOfBirth: description: Applicant state of birth. type: string country: description: Alpha-3 country code (e.g. `DEU` or `GBR`). type: string nationality: description: Alpha-3 country code. type: string addresses: description: List of applicant addresses. type: array items: description: >- WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema. tin: description: Tax identification number. type: string ApplicantChangeExtractedInfoRequest: type: object properties: firstName: description: The first name of the applicant. type: string lastName: description: The last name of the applicant. type: string middleName: description: The middle name of the applicant. type: string legalName: description: Legal name. type: string gender: description: An applicant gender (`M` or `F`). type: string dob: description: Applicant date of birth (format `YYYY-mm-dd`, e.g. 2001-09-25). type: string placeOfBirth: description: The applicant birthplace. type: string countryOfBirth: description: Applicant country of birth. type: string stateOfBirth: description: Applicant state of birth. type: string country: description: Alpha-3 country code (e.g. `DEU` or `GBR`). type: string nationality: description: Alpha-3 country code. type: string addresses: description: List of applicant addresses. type: string tin: description: Tax identification number. type: string ApplicantChangeExtractedInfoRequest1: type: object properties: firstName: description: The first name of the applicant. type: string lastName: description: The last name of the applicant. type: string middleName: description: The middle name of the applicant. type: string legalName: description: Legal name. type: string gender: description: An applicant gender (`M` or `F`). type: string dob: description: Applicant date of birth (format `YYYY-mm-dd`, e.g. 2001-09-25). type: string placeOfBirth: description: The applicant birthplace. type: string countryOfBirth: description: Applicant country of birth. type: string stateOfBirth: description: Applicant state of birth. type: string country: description: Alpha-3 country code (e.g. `DEU` or `GBR`). type: string nationality: description: Alpha-3 country code. type: string addresses: description: List of applicant addresses. type: string tin: description: Tax identification number. type: string ApplicantImportCompletedRequest: type: object properties: info: description: >- Holds the personal applicant information extracted during verification. type: object properties: firstName: description: The first name of the applicant. type: string lastName: description: The last name of the applicant. type: string middleName: description: The middle name of the applicant. type: string firstNameEn: description: Automatic transliteration of the first name. type: string lastNameEn: description: Automatic transliteration of the last name. type: string middleNameEn: description: Automatic transliteration of the middle name. type: string legalName: description: Legal name. type: string gender: description: An applicant gender (`M` or `F`). type: string dob: description: Applicant date of birth (format `YYYY-mm-dd`, e.g. 2001-09-25). type: string placeOfBirth: description: The applicant birthplace. type: string countryOfBirth: description: Applicant country of birth. type: string stateOfBirth: description: Applicant state of birth. type: string country: description: Alpha-3 country code (e.g. `DEU` or `GBR`). type: string nationality: description: Alpha-3 country code. type: string addresses: description: List of applicant addresses. type: array items: properties: country: description: Alpha-3 country code. type: string postCode: description: Postal code. type: string town: description: Town or city name. type: string street: description: Street name. type: string subStreet: description: Additional street information. type: string state: description: State name (if applicable). type: string buildingName: description: Building name (if applicable). type: string flatNumber: description: Flat or apartment number. type: string buildingNumber: description: Building number. type: string type: object tin: description: Tax identification number. type: string externalUserId: description: A unique applicant identifier as registered on your side. type: string review: description: Review results. type: object properties: createDate: description: >- Date of users' creation on your side in a format: "2022-11-21 08:25:32+0000" type: string reviewDate: description: 'review date on your side in a format: "2022-11-21 08:25:32+0000"' type: string review: type: object properties: moderationComment: description: Reason of rejection for end-user type: string clientComment: description: internal reason of rejection type: string reviewAnswer: description: '"GREEN"/"RED"' type: string reviewRejectType: description: '"FINAL"/"RETRY"(used only when "reviewAnswer"="RED")' type: string reviewStatus: description: '"completed"' type: string ApplicantImportCompletedRequest1: type: object properties: info: description: >- Holds the personal applicant information extracted during verification. type: object properties: firstName: description: The first name of the applicant. type: string lastName: description: The last name of the applicant. type: string middleName: description: The middle name of the applicant. type: string firstNameEn: description: Automatic transliteration of the first name. type: string lastNameEn: description: Automatic transliteration of the last name. type: string middleNameEn: description: Automatic transliteration of the middle name. type: string legalName: description: Legal name. type: string gender: description: An applicant gender (`M` or `F`). type: string dob: description: Applicant date of birth (format `YYYY-mm-dd`, e.g. 2001-09-25). type: string placeOfBirth: description: The applicant birthplace. type: string countryOfBirth: description: Applicant country of birth. type: string stateOfBirth: description: Applicant state of birth. type: string country: description: Alpha-3 country code (e.g. `DEU` or `GBR`). type: string nationality: description: Alpha-3 country code. type: string addresses: description: List of applicant addresses. type: array items: properties: country: description: Alpha-3 country code. type: string postCode: description: Postal code. type: string town: description: Town or city name. type: string street: description: Street name. type: string subStreet: description: Additional street information. type: string state: description: State name (if applicable). type: string buildingName: description: Building name (if applicable). type: string flatNumber: description: Flat or apartment number. type: string buildingNumber: description: Building number. type: string type: object tin: description: Tax identification number. type: string externalUserId: description: A unique applicant identifier as registered on your side. type: string review: description: Review results. type: object properties: createDate: description: >- Date of users' creation on your side in a format: "2022-11-21 08:25:32+0000" type: string reviewDate: description: 'review date on your side in a format: "2022-11-21 08:25:32+0000"' type: string review: type: object properties: moderationComment: description: Reason of rejection for end-user type: string clientComment: description: internal reason of rejection type: string reviewAnswer: description: '"GREEN"/"RED"' type: string reviewRejectType: description: '"FINAL"/"RETRY"(used only when "reviewAnswer"="RED")' type: string reviewStatus: description: '"completed"' type: string ApplicantImportByArchiveRequest: type: object properties: content: description: An archive file. type: string format: binary ApplicantImportByArchiveRequest1: type: object properties: content: description: An archive file. type: string format: binary ApplicantSandboxVerificationResponseRequest: type: object required: - reviewAnswer - rejectLabels properties: reviewAnswer: 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). type: string rejectLabels: description: >- An array of [rejection labels](/docs/receive-and-interpret-results-via-api#understand-rejection). type: array items: type: string reviewRejectType: description: >- A `FINAL` or `RETRY` rejection type indicating whether a rejection should be final or temporary. type: string clientComment: description: A rejection comment that should not be available to your applicants. type: string moderationComment: description: >- A comment that supposed to be shown to the applicant, explaining the reason of rejection. type: string ApplicantSandboxVerificationResponseRequest1: type: object required: - reviewAnswer - rejectLabels properties: reviewAnswer: 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). type: string rejectLabels: description: >- An array of [rejection labels](/docs/receive-and-interpret-results-via-api#understand-rejection). type: array items: type: string reviewRejectType: description: >- A `FINAL` or `RETRY` rejection type indicating whether a rejection should be final or temporary. type: string clientComment: description: A rejection comment that should not be available to your applicants. type: string moderationComment: description: >- A comment that supposed to be shown to the applicant, explaining the reason of rejection. type: string ApplicantAddCustomTagsRequest: type: object properties: RAW_BODY: type: array items: type: string ApplicantAddCustomTagsRequest1: type: object properties: RAW_BODY: type: array items: type: string ApplicantRemoveCustomTagsRequest: type: object properties: RAW_BODY: type: array items: type: string ApplicantRemoveCustomTagsRequest1: type: object properties: RAW_BODY: type: array items: type: string ApplicantAddCustomTagsRequest2: type: object properties: RAW_BODY: type: array items: type: string ApplicantAddCustomTagsRequest3: type: object properties: RAW_BODY: type: array items: type: string ApplicantAddConsentToProfileRequest: type: object required: - records properties: records: description: An array of applicant consents. type: array items: properties: content: description: Full raw consent text. type: string type: object acceptedAt: description: Date and time a consent was accepted by the applicant. type: string residenceCountry: description: >- An applicant country of residence in Alpha-3 format. For example, `USA` for the United States of America or `GBR` for Great Britain. type: string ApplicantAddConsentToProfileRequest1: type: object required: - records properties: records: description: An array of applicant consents. type: array items: properties: content: description: Full raw consent text. type: string type: object acceptedAt: description: Date and time a consent was accepted by the applicant. type: string residenceCountry: description: >- An applicant country of residence in Alpha-3 format. For example, `USA` for the United States of America or `GBR` for Great Britain. type: string ApplicantCreateActionRequest: type: object required: - externalActionId properties: externalActionId: description: An external action ID which will be bound to the token. type: string paymentMethod: 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. type: object required: - type properties: type: description: 'A payment type. Can be: `bankCard`, `eWallet`, `wireTransfer`.' type: string subType: description: A payment subtype. For example, `VISA`, `MASTERCARD`, etc. type: string data: description: >- An object that represents a payment method. `requiredIdDoc` contains information for comparison with the recognized image data from the applicant. type: object properties: requiredIdDoc: type: object properties: firstName: type: string lastName: type: string middleName: type: string number: type: string issuedDate: type: string txnAmount: type: string email: description: Applicant email address. type: string phone: description: Applicant phone number. type: string ApplicantCreateActionRequest1: type: object required: - externalActionId properties: externalActionId: description: An external action ID which will be bound to the token. type: string paymentMethod: 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. type: object required: - type properties: type: description: 'A payment type. Can be: `bankCard`, `eWallet`, `wireTransfer`.' type: string subType: description: A payment subtype. For example, `VISA`, `MASTERCARD`, etc. type: string data: description: >- An object that represents a payment method. `requiredIdDoc` contains information for comparison with the recognized image data from the applicant. type: object properties: requiredIdDoc: type: object properties: firstName: type: string lastName: type: string middleName: type: string number: type: string issuedDate: type: string txnAmount: type: string email: description: Applicant email address. type: string phone: description: Applicant phone number. type: string ApplicantCreatePaymentSourceActionsRequest: type: object properties: externalActionId: description: An external identifier for an action. type: string paymentSource: description: Data on a payment source. type: object properties: fixedInfo: description: Additional fixed information related to a payment source. type: object properties: accountIdentifier: description: A unique identifier for an account (e.g., "123456"). type: string email: description: An email address associated with a particular account. type: string fullName: description: The full name of an account holder (e.g., "Alex Kim"). type: string institutionName: description: >- A name of the financial institution where an account is held (e.g., Revolut). type: string type: description: A payment source type. type: string enum: - bankCard - bankStatement - eWallet - cryptoWallet ApplicantCreatePaymentSourceActionsRequest1: type: object properties: externalActionId: description: An external identifier for an action. type: string paymentSource: description: Data on a payment source. type: object properties: fixedInfo: description: Additional fixed information related to a payment source. type: object properties: accountIdentifier: description: A unique identifier for an account (e.g., "123456"). type: string email: description: An email address associated with a particular account. type: string fullName: description: The full name of an account holder (e.g., "Alex Kim"). type: string institutionName: description: >- A name of the financial institution where an account is held (e.g., Revolut). type: string type: description: A payment source type. type: string enum: - bankCard - bankStatement - eWallet - cryptoWallet ApplicantAddPaymentMethodInformationRequest: type: object required: - type properties: type: description: 'A payment type. Can be: `bankCard`, `eWallet`, `wireTransfer`.' type: string subType: description: A payment subtype. For example, `VISA`, `MASTERCARD`, etc. type: string data: description: >- An object that represents a payment method. `requiredIdDoc` contains information for comparison with the recognized image data from the applicant. type: object properties: requiredIdDoc: type: object properties: firstName: type: string lastName: type: string middleName: type: string number: type: string issuedDate: type: string txnAmount: type: string ApplicantAddPaymentMethodInformationRequest1: type: object required: - type properties: type: description: 'A payment type. Can be: `bankCard`, `eWallet`, `wireTransfer`.' type: string subType: description: A payment subtype. For example, `VISA`, `MASTERCARD`, etc. type: string data: description: >- An object that represents a payment method. `requiredIdDoc` contains information for comparison with the recognized image data from the applicant. type: object properties: requiredIdDoc: type: object properties: firstName: type: string lastName: type: string middleName: type: string number: type: string issuedDate: type: string txnAmount: type: string ApplicantAddImageToPaymentMethodRequest: type: object required: - content - metadata properties: content: description: A document photo. type: string format: binary metadata: description: An object representing a payment method. type: object required: - idDocType - country properties: idDocType: type: string country: type: string ApplicantAddImageToPaymentMethodRequest1: type: object required: - content - metadata properties: content: description: A document photo. type: string format: binary metadata: description: An object representing a payment method. type: object required: - idDocType - country properties: idDocType: type: string country: type: string ApplicantCreateCryptoSourceOfFundsRequest: type: object required: - currency - direction - address properties: currency: description: '`BTC`, `ETH`, `BCH`, `LTC`, `USDT`, `ERC-20`, `BSV`, `XLM`, ...' type: string direction: description: Operation type. Can be `withdrawal` or `deposit`. type: string txn: description: >- Transaction hash. For `withdrawals`, `txn` should not be set at all or set to `null`. type: string address: description: Target address hash. type: string tokenId: description: >- Check the [Get available tokens](ref:get-available-tokens) method to get the full list of available currencies and token IDs. type: string ApplicantCreateCryptoSourceOfFundsRequest1: type: object required: - currency - direction - address properties: currency: description: '`BTC`, `ETH`, `BCH`, `LTC`, `USDT`, `ERC-20`, `BSV`, `XLM`, ...' type: string direction: description: Operation type. Can be `withdrawal` or `deposit`. type: string txn: description: >- Transaction hash. For `withdrawals`, `txn` should not be set at all or set to `null`. type: string address: description: Target address hash. type: string tokenId: description: >- Check the [Get available tokens](ref:get-available-tokens) method to get the full list of available currencies and token IDs. type: string AnalysisStandaloneCryptoInitiationRequest: type: object required: - currency - direction - address properties: currency: description: '`BTC`, `ETH`, `BCH`, `LTC`, `USDT`, `ERC-20`, `BSV`, `XLM`, ...' type: string direction: description: An operation type. Can be `withdrawal` or `deposit`. type: string txn: description: >- Transaction hash. For `withdrawals`, `txn` should not be set at all or set to `null`. type: string address: description: Target address hash. type: string tokenId: description: >- Check the [Get available tokens](ref:get-available-tokens) method to get the full list of available currencies and token IDs. type: string AnalysisStandaloneCryptoInitiationRequest1: type: object required: - currency - direction - address properties: currency: description: '`BTC`, `ETH`, `BCH`, `LTC`, `USDT`, `ERC-20`, `BSV`, `XLM`, ...' type: string direction: description: An operation type. Can be `withdrawal` or `deposit`. type: string txn: description: >- Transaction hash. For `withdrawals`, `txn` should not be set at all or set to `null`. type: string address: description: Target address hash. type: string tokenId: description: >- Check the [Get available tokens](ref:get-available-tokens) method to get the full list of available currencies and token IDs. type: string ApplicantAddBeneficiaryRequest: type: object required: - applicant - applicantId - type properties: applicant: description: An object that represents an individual applicant identifier. type: object properties: id: description: applicantId of beneficiary type: string applicantId: description: Beneficiary applicant identifier. type: string positions: description: >- The list of positions in the company (`["director", "shareholder", "other"]`). type: array items: type: string type: description: Beneficiary type. type: string enum: - ubo - shareholder - representative - director ApplicantAddBeneficiaryRequest1: type: object required: - applicant - applicantId - type properties: applicant: description: An object that represents an individual applicant identifier. type: object properties: id: description: applicantId of beneficiary type: string applicantId: description: Beneficiary applicant identifier. type: string positions: description: >- The list of positions in the company (`["director", "shareholder", "other"]`). type: array items: type: string type: description: Beneficiary type. type: string enum: - ubo - shareholder - representative - director ApplicantChangeCompanyDataRequest: type: object required: - companyName - registrationNumber properties: companyName: description: Company name. type: string registrationNumber: description: Registration number. type: string country: description: A three-letter country code (e.g. `DEU`). type: string legalAddress: description: Legal name. type: string incorporatedOn: description: Date of incorporation (format `YYYY-mm-dd`, e.g. 2001-09-25). type: string type: description: Type of entity. type: string email: description: Email address. type: string controlScheme: description: Description of the control scheme of the group of entities. type: string phone: description: Phone number. type: string taxId: description: Taxpayer registration number/Code of taxpayer registration. type: string registrationLocation: description: Location of registration. type: string website: description: Website URL. type: string postalAddress: description: Postal address. type: string beneficiaries: description: >- Applicant IDs of beneficiaries and additional info like position and type. type: array items: description: >- WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema. addresses: description: List of addresses. type: array items: type: string ApplicantChangeCompanyDataRequest1: type: object required: - companyName - registrationNumber properties: companyName: description: Company name. type: string registrationNumber: description: Registration number. type: string country: description: A three-letter country code (e.g. `DEU`). type: string legalAddress: description: Legal name. type: string incorporatedOn: description: Date of incorporation (format `YYYY-mm-dd`, e.g. 2001-09-25). type: string type: description: Type of entity. type: string email: description: Email address. type: string controlScheme: description: Description of the control scheme of the group of entities. type: string phone: description: Phone number. type: string taxId: description: Taxpayer registration number/Code of taxpayer registration. type: string registrationLocation: description: Location of registration. type: string website: description: Website URL. type: string postalAddress: description: Postal address. type: string beneficiaries: description: >- Applicant IDs of beneficiaries and additional info like position and type. type: array items: description: >- WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema. addresses: description: List of addresses. type: array items: type: string VerificationSubmitApplicantDataRequest: type: object properties: info: description: Information about the applicant. type: object properties: country: description: Alpha-3 country code. type: string enum: - ARG - BGD - BRA - GBR - IDN - IND - KEN - MEX - NGA - NLD - VNM - ZAF tin: description: Tax identifier. type: string firstName: description: The first name of the applicant. type: string idDoc: description: Information about the document. type: object properties: country: description: Alpha-3 country code. type: string enum: - ARG - BGD - BRA - GBR - IDN - IND - KEN - MEX - NGA - NLD - VNM - ZAF idDocType: description: Document type. type: string number: description: Document number. type: string gender: description: Applicant's gender. type: string dob: description: Applicant's date of birth. type: string firstName: description: The first name of the applicant. type: string lastName: description: The last name of the applicant. type: string VerificationSubmitApplicantDataRequest1: type: object properties: info: description: Information about the applicant. type: object properties: country: description: Alpha-3 country code. type: string enum: - ARG - BGD - BRA - GBR - IDN - IND - KEN - MEX - NGA - NLD - VNM - ZAF tin: description: Tax identifier. type: string firstName: description: The first name of the applicant. type: string idDoc: description: Information about the document. type: object properties: country: description: Alpha-3 country code. type: string enum: - ARG - BGD - BRA - GBR - IDN - IND - KEN - MEX - NGA - NLD - VNM - ZAF idDocType: description: Document type. type: string number: description: Document number. type: string gender: description: Applicant's gender. type: string dob: description: Applicant's date of birth. type: string firstName: description: The first name of the applicant. type: string lastName: description: The last name of the applicant. type: string ApplicantConfirmDataRequest: type: object properties: otp: description: OTP confirmation data if `confirmationType` is `otp`. type: object required: - code properties: code: description: OTP that was sent to applicant. type: string oauth: description: oAuth confirmation data if `confirmationType` is `oAuth`. type: object required: - completeUrl properties: completeUrl: description: >- Final redirected URL of the auth journey with query params. Format: `redirectUrl?`. type: string ApplicantConfirmDataRequest1: type: object properties: otp: description: OTP confirmation data if `confirmationType` is `otp`. type: object required: - code properties: code: description: OTP that was sent to applicant. type: string oauth: description: oAuth confirmation data if `confirmationType` is `oAuth`. type: object required: - completeUrl properties: completeUrl: description: >- Final redirected URL of the auth journey with query params. Format: `redirectUrl?`. type: string ApplicantSubmitTransactionDataRequest: type: object required: - txnId - info - applicant - counterparty properties: info: description: An object representing transaction information. type: object required: - direction - amount - currencyCode properties: direction: description: >- Can be `out` (applicant sends to counterparty) or `in` (counterparty sends to applicant). type: string amount: description: The amount of funds used in this transaction. type: number format: double amountInDefaultCurrency: 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. type: number format: double currencyType: description: Indicates whether the transaction is `crypto` or `fiat`. type: string currencyCode: description: Currency code (`USD`, `GBP`, `BTC`, etc). type: string cryptoParams: description: >- Includes crypto transaction parameters. It is crucial for Sumsub to understand which crypto chain is used to correctly utilize the data. type: object required: - attemptId properties: attemptId: description: Unique identifier of the transaction attempt. type: string outputIndex: description: An index number for a transaction output. type: integer format: int32 cryptoChain: 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). type: string paymentTxnId: description: >- Crypto transaction ID from the blockchain. Required for crypto check requests only. type: string paymentDetails: description: A comment with payment details. type: string type: description: >- Accepts any value that helps you categorize transactions. For example, for gambling transactions, you can specify `bonus`, `payroll`, or `cashback`. type: string txnId: description: >- A unique transaction identification number.
**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). type: string txnDate: 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). type: string format: date applicant: description: >- Transaction participant data with mandatory `applicantId` (sender or remitter, depending on `info.direction`). type: object required: - externalUserId - fullName - type properties: externalUserId: 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. type: string fullName: description: Full name of the participant. type: string type: description: >- Participant entity type: `company` or `individual`. Set to `individual` by default. type: string default: individual address: description: Participant address. type: object properties: country: description: Alpha-3 country code. type: string postCode: description: Postal code. type: string town: description: Town or city name. type: string street: description: Street name. type: string subStreet: description: Additional street information. type: string state: description: State name (if applicable). type: string buildingName: description: Building name (if applicable). type: string flatNumber: description: Flat or apartment number. type: string buildingNumber: description: Building number. type: string institutionInfo: description: Transaction institution information type: object properties: code: description: Transaction institution code. type: string name: description: Transaction institution name. type: string address: description: Transaction institution address. type: object properties: country: description: Alpha-3 country code. type: string postCode: description: Postal code. type: string town: description: Town or city name. type: string street: description: Street name. type: string subStreet: description: Additional street information. type: string state: description: State name (if applicable). type: string buildingName: description: Building name (if applicable). type: string flatNumber: description: Flat or apartment number. type: string buildingNumber: description: Building number. type: string internalId: description: >- VASP ID for counterparty transaction. If provided, we trust the exchange and use the expected VASP for transaction approval. type: string paymentMethod: description: Information about the payment method. type: object properties: type: description: 'Payment method type: `card`/`account`/`crypto`.' type: string accountId: description: >- Representation of the account ID: Account number, IBAN or DC hash for `card`, crypto wallet address for `crypto` type etc. type: string issuingCountry: description: The payment issuing country code in Alpha-3 format. type: string 3dsUsed: description: Indication of 3d secure auth being used. type: boolean 2faUsed: description: Indication of 2fa being used. type: boolean device: description: Device information. type: object properties: userAgent: description: Device user agent. type: string sessionId: description: Transaction session identifier. type: string sessionAgeMs: description: Session lifetime in milliseconds. type: integer format: int64 acceptLang: description: From browser, e.g. `en`. type: string platform: description: Device platform, e.g. `Mobile Android`. type: string fingerprint: description: Device fingerprint. type: string address: description: Device address. type: object properties: country: description: Alpha-3 country code. type: string postCode: description: Postal code. type: string town: description: Town or city name. type: string street: description: Street name. type: string subStreet: description: Additional street information. type: string state: description: State name (if applicable). type: string buildingName: description: Building name (if applicable). type: string flatNumber: description: Flat or apartment number. type: string buildingNumber: description: Building number. type: string coords: description: Coordinates. type: object properties: lat: description: Position latitude in decimal degrees. type: number format: double lon: description: Position longitude in decimal degrees. type: number format: double accuracy: description: >- Accuracy of the latitude and longitude properties, expressed in meters. # type: string ipInfo: description: Data about used IP address. type: object properties: lat: description: Position latitude in decimal degrees. type: number format: double lon: description: Position longitude in decimal degrees. type: number format: double ip: description: IP address. type: string countryCode3: description: Country Alpha-3 code. type: string asn: description: ASN. type: integer format: int32 asnOrg: description: ASN organisation. type: string riskyAsn: description: ASN is risky or not. type: boolean counterparty: description: >- Transaction participant data (sender or remitter, depending on `info.direction`). type: object required: - externalUserId - fullName - type properties: externalUserId: 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. type: string fullName: description: Full name of the participant. type: string type: description: >- Participant entity type: `company` or `individual`. Set to `individual` by default. type: string default: individual address: description: Participant address. type: object properties: country: description: Alpha-3 country code. type: string postCode: description: Postal code. type: string town: description: Town or city name. type: string street: description: Street name. type: string subStreet: description: Additional street information. type: string state: description: State name (if applicable). type: string buildingName: description: Building name (if applicable). type: string flatNumber: description: Flat or apartment number. type: string buildingNumber: description: Building number. type: string institutionInfo: description: Transaction institution information type: object properties: code: description: Transaction institution code. type: string name: description: Transaction institution name. type: string address: description: Transaction institution address. type: object properties: country: description: Alpha-3 country code. type: string postCode: description: Postal code. type: string town: description: Town or city name. type: string street: description: Street name. type: string subStreet: description: Additional street information. type: string state: description: State name (if applicable). type: string buildingName: description: Building name (if applicable). type: string flatNumber: description: Flat or apartment number. type: string buildingNumber: description: Building number. type: string internalId: description: >- VASP ID for counterparty transaction. If provided, we trust the exchange and use the expected VASP for transaction approval. type: string paymentMethod: description: Information about the payment method. type: object properties: type: description: 'Payment method type: `card`/`account`/`crypto`.' type: string accountId: description: >- Representation of the account ID: Account number, IBAN or DC hash for `card`, crypto wallet address for `crypto` type etc. type: string issuingCountry: description: The payment issuing country code in Alpha-3 format. type: string 3dsUsed: description: Indication of 3d secure auth being used. type: boolean 2faUsed: description: Indication of 2fa being used. type: boolean device: description: Device information. type: object properties: userAgent: description: Device user agent. type: string sessionId: description: Transaction session identifier. type: string sessionAgeMs: description: Session lifetime in milliseconds. type: integer format: int64 acceptLang: description: From browser, e.g. `en`. type: string platform: description: Device platform, e.g. `Mobile Android`. type: string fingerprint: description: Device fingerprint. type: string address: description: Device address. type: object properties: country: description: Alpha-3 country code. type: string postCode: description: Postal code. type: string town: description: Town or city name. type: string street: description: Street name. type: string subStreet: description: Additional street information. type: string state: description: State name (if applicable). type: string buildingName: description: Building name (if applicable). type: string flatNumber: description: Flat or apartment number. type: string buildingNumber: description: Building number. type: string coords: description: Coordinates. type: object properties: lat: description: Position latitude in decimal degrees. type: number format: double lon: description: Position longitude in decimal degrees. type: number format: double accuracy: description: >- Accuracy of the latitude and longitude properties, expressed in meters. # type: string ipInfo: description: Data about used IP address. type: object properties: lat: description: Position latitude in decimal degrees. type: number format: double lon: description: Position longitude in decimal degrees. type: number format: double ip: description: IP address. type: string countryCode3: description: Country Alpha-3 code. type: string asn: description: ASN. type: integer format: int32 asnOrg: description: ASN organisation. type: string riskyAsn: description: ASN is risky or not. type: boolean type: description: >- A transaction type. Expects values:
  • finance(default)
  • gamblingBet
  • gamblingLimitChange
  • gamblingBonusChange
  • kyc
  • travelRule
  • userPlatformEvent
    • login
    • signup
    • passwordChange
    • twoFaReset
type: string default: finance sourceKey: description: A source key indication to separate access to transactions. type: string props: description: >- A map of strings in JSON format with custom keys and string values. Represents transaction properties. type: object properties: customTxnLimit: type: string default: '1000' ApplicantSubmitTransactionDataRequest1: type: object required: - txnId - info - applicant - counterparty properties: info: description: An object representing transaction information. type: object required: - direction - amount - currencyCode properties: direction: description: >- Can be `out` (applicant sends to counterparty) or `in` (counterparty sends to applicant). type: string amount: description: The amount of funds used in this transaction. type: number format: double amountInDefaultCurrency: 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. type: number format: double currencyType: description: Indicates whether the transaction is `crypto` or `fiat`. type: string currencyCode: description: Currency code (`USD`, `GBP`, `BTC`, etc). type: string cryptoParams: description: >- Includes crypto transaction parameters. It is crucial for Sumsub to understand which crypto chain is used to correctly utilize the data. type: object required: - attemptId properties: attemptId: description: Unique identifier of the transaction attempt. type: string outputIndex: description: An index number for a transaction output. type: integer format: int32 cryptoChain: 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). type: string paymentTxnId: description: >- Crypto transaction ID from the blockchain. Required for crypto check requests only. type: string paymentDetails: description: A comment with payment details. type: string type: description: >- Accepts any value that helps you categorize transactions. For example, for gambling transactions, you can specify `bonus`, `payroll`, or `cashback`. type: string txnId: description: >- A unique transaction identification number.
**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). type: string txnDate: 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). type: string format: date applicant: description: >- Transaction participant data with mandatory `applicantId` (sender or remitter, depending on `info.direction`). type: object required: - externalUserId - fullName - type properties: externalUserId: 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. type: string fullName: description: Full name of the participant. type: string type: description: >- Participant entity type: `company` or `individual`. Set to `individual` by default. type: string default: individual address: description: Participant address. type: object properties: country: description: Alpha-3 country code. type: string postCode: description: Postal code. type: string town: description: Town or city name. type: string street: description: Street name. type: string subStreet: description: Additional street information. type: string state: description: State name (if applicable). type: string buildingName: description: Building name (if applicable). type: string flatNumber: description: Flat or apartment number. type: string buildingNumber: description: Building number. type: string institutionInfo: description: Transaction institution information type: object properties: code: description: Transaction institution code. type: string name: description: Transaction institution name. type: string address: description: Transaction institution address. type: object properties: country: description: Alpha-3 country code. type: string postCode: description: Postal code. type: string town: description: Town or city name. type: string street: description: Street name. type: string subStreet: description: Additional street information. type: string state: description: State name (if applicable). type: string buildingName: description: Building name (if applicable). type: string flatNumber: description: Flat or apartment number. type: string buildingNumber: description: Building number. type: string internalId: description: >- VASP ID for counterparty transaction. If provided, we trust the exchange and use the expected VASP for transaction approval. type: string paymentMethod: description: Information about the payment method. type: object properties: type: description: 'Payment method type: `card`/`account`/`crypto`.' type: string accountId: description: >- Representation of the account ID: Account number, IBAN or DC hash for `card`, crypto wallet address for `crypto` type etc. type: string issuingCountry: description: The payment issuing country code in Alpha-3 format. type: string 3dsUsed: description: Indication of 3d secure auth being used. type: boolean 2faUsed: description: Indication of 2fa being used. type: boolean device: description: Device information. type: object properties: userAgent: description: Device user agent. type: string sessionId: description: Transaction session identifier. type: string sessionAgeMs: description: Session lifetime in milliseconds. type: integer format: int64 acceptLang: description: From browser, e.g. `en`. type: string platform: description: Device platform, e.g. `Mobile Android`. type: string fingerprint: description: Device fingerprint. type: string address: description: Device address. type: object properties: country: description: Alpha-3 country code. type: string postCode: description: Postal code. type: string town: description: Town or city name. type: string street: description: Street name. type: string subStreet: description: Additional street information. type: string state: description: State name (if applicable). type: string buildingName: description: Building name (if applicable). type: string flatNumber: description: Flat or apartment number. type: string buildingNumber: description: Building number. type: string coords: description: Coordinates. type: object properties: lat: description: Position latitude in decimal degrees. type: number format: double lon: description: Position longitude in decimal degrees. type: number format: double accuracy: description: >- Accuracy of the latitude and longitude properties, expressed in meters. # type: string ipInfo: description: Data about used IP address. type: object properties: lat: description: Position latitude in decimal degrees. type: number format: double lon: description: Position longitude in decimal degrees. type: number format: double ip: description: IP address. type: string countryCode3: description: Country Alpha-3 code. type: string asn: description: ASN. type: integer format: int32 asnOrg: description: ASN organisation. type: string riskyAsn: description: ASN is risky or not. type: boolean counterparty: description: >- Transaction participant data (sender or remitter, depending on `info.direction`). type: object required: - externalUserId - fullName - type properties: externalUserId: 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. type: string fullName: description: Full name of the participant. type: string type: description: >- Participant entity type: `company` or `individual`. Set to `individual` by default. type: string default: individual address: description: Participant address. type: object properties: country: description: Alpha-3 country code. type: string postCode: description: Postal code. type: string town: description: Town or city name. type: string street: description: Street name. type: string subStreet: description: Additional street information. type: string state: description: State name (if applicable). type: string buildingName: description: Building name (if applicable). type: string flatNumber: description: Flat or apartment number. type: string buildingNumber: description: Building number. type: string institutionInfo: description: Transaction institution information type: object properties: code: description: Transaction institution code. type: string name: description: Transaction institution name. type: string address: description: Transaction institution address. type: object properties: country: description: Alpha-3 country code. type: string postCode: description: Postal code. type: string town: description: Town or city name. type: string street: description: Street name. type: string subStreet: description: Additional street information. type: string state: description: State name (if applicable). type: string buildingName: description: Building name (if applicable). type: string flatNumber: description: Flat or apartment number. type: string buildingNumber: description: Building number. type: string internalId: description: >- VASP ID for counterparty transaction. If provided, we trust the exchange and use the expected VASP for transaction approval. type: string paymentMethod: description: Information about the payment method. type: object properties: type: description: 'Payment method type: `card`/`account`/`crypto`.' type: string accountId: description: >- Representation of the account ID: Account number, IBAN or DC hash for `card`, crypto wallet address for `crypto` type etc. type: string issuingCountry: description: The payment issuing country code in Alpha-3 format. type: string 3dsUsed: description: Indication of 3d secure auth being used. type: boolean 2faUsed: description: Indication of 2fa being used. type: boolean device: description: Device information. type: object properties: userAgent: description: Device user agent. type: string sessionId: description: Transaction session identifier. type: string sessionAgeMs: description: Session lifetime in milliseconds. type: integer format: int64 acceptLang: description: From browser, e.g. `en`. type: string platform: description: Device platform, e.g. `Mobile Android`. type: string fingerprint: description: Device fingerprint. type: string address: description: Device address. type: object properties: country: description: Alpha-3 country code. type: string postCode: description: Postal code. type: string town: description: Town or city name. type: string street: description: Street name. type: string subStreet: description: Additional street information. type: string state: description: State name (if applicable). type: string buildingName: description: Building name (if applicable). type: string flatNumber: description: Flat or apartment number. type: string buildingNumber: description: Building number. type: string coords: description: Coordinates. type: object properties: lat: description: Position latitude in decimal degrees. type: number format: double lon: description: Position longitude in decimal degrees. type: number format: double accuracy: description: >- Accuracy of the latitude and longitude properties, expressed in meters. # type: string ipInfo: description: Data about used IP address. type: object properties: lat: description: Position latitude in decimal degrees. type: number format: double lon: description: Position longitude in decimal degrees. type: number format: double ip: description: IP address. type: string countryCode3: description: Country Alpha-3 code. type: string asn: description: ASN. type: integer format: int32 asnOrg: description: ASN organisation. type: string riskyAsn: description: ASN is risky or not. type: boolean type: description: >- A transaction type. Expects values:
  • finance(default)
  • gamblingBet
  • gamblingLimitChange
  • gamblingBonusChange
  • kyc
  • travelRule
  • userPlatformEvent
    • login
    • signup
    • passwordChange
    • twoFaReset
type: string default: finance sourceKey: description: A source key indication to separate access to transactions. type: string props: description: >- A map of strings in JSON format with custom keys and string values. Represents transaction properties. type: object properties: customTxnLimit: type: string default: '1000' ApplicantSubmitTransactionForNonExistingRequest: type: object required: - txnId - info - applicant - counterparty properties: info: description: An object representing transaction information. type: object required: - direction - amount - currencyCode properties: direction: description: >- Can be `out` (applicant sends to counterparty) or `in` (counterparty sends to applicant). type: string amount: description: The amount of funds used in this transaction. type: number format: double amountInDefaultCurrency: 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. type: number format: double currencyType: description: Indicates whether the transaction is `crypto` or `fiat`. type: string currencyCode: description: Currency code (`USD`, `GBP`, `BTC`, etc). type: string cryptoParams: description: >- Includes crypto transaction parameters. It is crucial for Sumsub to understand which crypto chain is used to correctly utilize the data. type: object required: - attemptId properties: attemptId: description: Unique identifier of the transaction attempt. type: string outputIndex: description: An index number for a transaction output. type: integer format: int32 cryptoChain: 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). type: string paymentTxnId: description: >- Crypto transaction ID from the blockchain. Required for crypto check requests only. type: string paymentDetails: description: A comment with payment details. type: string type: description: >- Accepts any value that helps you categorize transactions. For example, for gambling transactions, you can specify `bonus`, `payroll`, or `cashback`. type: string txnId: description: A unique transaction identification number. type: string txnDate: 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). type: string format: date props: description: >- Transaction properties. Map of strings (JSON) of custom keys and string values. type: object properties: {} applicant: description: >- Transaction participant data with mandatory `applicantId` (sender or remitter, depending on `info.direction`). type: object required: - externalUserId - fullName - type properties: externalUserId: 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. type: string fullName: description: Full name of the participant. type: string type: description: >- Participant entity type: `company` or `individual`. Set to `individual` by default. type: string default: individual address: description: Participant address. type: object properties: country: description: Alpha-3 country code. type: string postCode: description: Postal code. type: string town: description: Town or city name. type: string street: description: Street name. type: string subStreet: description: Additional street information. type: string state: description: State name (if applicable). type: string buildingName: description: Building name (if applicable). type: string flatNumber: description: Flat or apartment number. type: string buildingNumber: description: Building number. type: string institutionInfo: description: Transaction institution information type: object properties: code: description: Transaction institution code. type: string name: description: Transaction institution name. type: string address: description: Transaction institution address. type: object properties: country: description: Alpha-3 country code. type: string postCode: description: Postal code. type: string town: description: Town or city name. type: string street: description: Street name. type: string subStreet: description: Additional street information. type: string state: description: State name (if applicable). type: string buildingName: description: Building name (if applicable). type: string flatNumber: description: Flat or apartment number. type: string buildingNumber: description: Building number. type: string internalId: description: >- VASP ID for counterparty transaction. If provided, we trust the exchange and use the expected VASP for transaction approval. type: string paymentMethod: description: Information about the payment method. type: object properties: type: description: 'Payment method type: `card`/`account`/`crypto`.' type: string accountId: description: >- Representation of the account ID: Account number, IBAN or DC hash for `card`, crypto wallet address for `crypto` type etc. type: string issuingCountry: description: The payment issuing country code in Alpha-3 format. type: string 3dsUsed: description: Indication of 3d secure auth being used. type: boolean 2faUsed: description: Indication of 2fa being used. type: boolean device: description: Device information. type: object properties: userAgent: description: Device user agent. type: string sessionId: description: Transaction session identifier. type: string sessionAgeMs: description: Session lifetime in milliseconds. type: integer format: int64 acceptLang: description: From browser, e.g. `en`. type: string platform: description: Device platform, e.g. `Mobile Android`. type: string fingerprint: description: Device fingerprint. type: string address: description: Device address. type: object properties: country: description: Alpha-3 country code. type: string postCode: description: Postal code. type: string town: description: Town or city name. type: string street: description: Street name. type: string subStreet: description: Additional street information. type: string state: description: State name (if applicable). type: string buildingName: description: Building name (if applicable). type: string flatNumber: description: Flat or apartment number. type: string buildingNumber: description: Building number. type: string coords: description: Coordinates. type: object properties: lat: description: Position latitude in decimal degrees. type: number format: double lon: description: Position longitude in decimal degrees. type: number format: double accuracy: description: >- Accuracy of the latitude and longitude properties, expressed in meters. # type: string ipInfo: description: Data about used IP address. type: object properties: lat: description: Position latitude in decimal degrees. type: number format: double lon: description: Position longitude in decimal degrees. type: number format: double ip: description: IP address. type: string countryCode3: description: Country Alpha-3 code. type: string asn: description: ASN. type: integer format: int32 asnOrg: description: ASN organisation. type: string riskyAsn: description: ASN is risky or not. type: boolean counterparty: description: >- Transaction participant data (sender or remitter, depending on `info.direction`). type: object required: - externalUserId - fullName - type properties: externalUserId: 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. type: string fullName: description: Full name of the participant. type: string type: description: >- Participant entity type: `company` or `individual`. Set to `individual` by default. type: string default: individual address: description: Participant address. type: object properties: country: description: Alpha-3 country code. type: string postCode: description: Postal code. type: string town: description: Town or city name. type: string street: description: Street name. type: string subStreet: description: Additional street information. type: string state: description: State name (if applicable). type: string buildingName: description: Building name (if applicable). type: string flatNumber: description: Flat or apartment number. type: string buildingNumber: description: Building number. type: string institutionInfo: description: Transaction institution information type: object properties: code: description: Transaction institution code. type: string name: description: Transaction institution name. type: string address: description: Transaction institution address. type: object properties: country: description: Alpha-3 country code. type: string postCode: description: Postal code. type: string town: description: Town or city name. type: string street: description: Street name. type: string subStreet: description: Additional street information. type: string state: description: State name (if applicable). type: string buildingName: description: Building name (if applicable). type: string flatNumber: description: Flat or apartment number. type: string buildingNumber: description: Building number. type: string internalId: description: >- VASP ID for counterparty transaction. If provided, we trust the exchange and use the expected VASP for transaction approval. type: string paymentMethod: description: Information about the payment method. type: object properties: type: description: 'Payment method type: `card`/`account`/`crypto`.' type: string accountId: description: >- Representation of the account ID: Account number, IBAN or DC hash for `card`, crypto wallet address for `crypto` type etc. type: string issuingCountry: description: The payment issuing country code in Alpha-3 format. type: string 3dsUsed: description: Indication of 3d secure auth being used. type: boolean 2faUsed: description: Indication of 2fa being used. type: boolean device: description: Device information. type: object properties: userAgent: description: Device user agent. type: string sessionId: description: Transaction session identifier. type: string sessionAgeMs: description: Session lifetime in milliseconds. type: integer format: int64 acceptLang: description: From browser, e.g. `en`. type: string platform: description: Device platform, e.g. `Mobile Android`. type: string fingerprint: description: Device fingerprint. type: string address: description: Device address. type: object properties: country: description: Alpha-3 country code. type: string postCode: description: Postal code. type: string town: description: Town or city name. type: string street: description: Street name. type: string subStreet: description: Additional street information. type: string state: description: State name (if applicable). type: string buildingName: description: Building name (if applicable). type: string flatNumber: description: Flat or apartment number. type: string buildingNumber: description: Building number. type: string coords: description: Coordinates. type: object properties: lat: description: Position latitude in decimal degrees. type: number format: double lon: description: Position longitude in decimal degrees. type: number format: double accuracy: description: >- Accuracy of the latitude and longitude properties, expressed in meters. # type: string ipInfo: description: Data about used IP address. type: object properties: lat: description: Position latitude in decimal degrees. type: number format: double lon: description: Position longitude in decimal degrees. type: number format: double ip: description: IP address. type: string countryCode3: description: Country Alpha-3 code. type: string asn: description: ASN. type: integer format: int32 asnOrg: description: ASN organisation. type: string riskyAsn: description: ASN is risky or not. type: boolean type: description: >- A transaction type. Expects values:
  • finance(default)
  • gamblingBet
  • gamblingLimitChange
  • gamblingBonusChange
  • kyc
  • travelRule
  • userPlatformEvent
    • login
    • signup
    • passwordChange
    • twoFaReset
type: string default: finance sourceKey: description: A source key indication to separate access to transactions. type: string ApplicantSubmitTransactionForNonExistingRequest1: type: object required: - txnId - info - applicant - counterparty properties: info: description: An object representing transaction information. type: object required: - direction - amount - currencyCode properties: direction: description: >- Can be `out` (applicant sends to counterparty) or `in` (counterparty sends to applicant). type: string amount: description: The amount of funds used in this transaction. type: number format: double amountInDefaultCurrency: 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. type: number format: double currencyType: description: Indicates whether the transaction is `crypto` or `fiat`. type: string currencyCode: description: Currency code (`USD`, `GBP`, `BTC`, etc). type: string cryptoParams: description: >- Includes crypto transaction parameters. It is crucial for Sumsub to understand which crypto chain is used to correctly utilize the data. type: object required: - attemptId properties: attemptId: description: Unique identifier of the transaction attempt. type: string outputIndex: description: An index number for a transaction output. type: integer format: int32 cryptoChain: 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). type: string paymentTxnId: description: >- Crypto transaction ID from the blockchain. Required for crypto check requests only. type: string paymentDetails: description: A comment with payment details. type: string type: description: >- Accepts any value that helps you categorize transactions. For example, for gambling transactions, you can specify `bonus`, `payroll`, or `cashback`. type: string txnId: description: A unique transaction identification number. type: string txnDate: 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). type: string format: date props: description: >- Transaction properties. Map of strings (JSON) of custom keys and string values. type: object properties: {} applicant: description: >- Transaction participant data with mandatory `applicantId` (sender or remitter, depending on `info.direction`). type: object required: - externalUserId - fullName - type properties: externalUserId: 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. type: string fullName: description: Full name of the participant. type: string type: description: >- Participant entity type: `company` or `individual`. Set to `individual` by default. type: string default: individual address: description: Participant address. type: object properties: country: description: Alpha-3 country code. type: string postCode: description: Postal code. type: string town: description: Town or city name. type: string street: description: Street name. type: string subStreet: description: Additional street information. type: string state: description: State name (if applicable). type: string buildingName: description: Building name (if applicable). type: string flatNumber: description: Flat or apartment number. type: string buildingNumber: description: Building number. type: string institutionInfo: description: Transaction institution information type: object properties: code: description: Transaction institution code. type: string name: description: Transaction institution name. type: string address: description: Transaction institution address. type: object properties: country: description: Alpha-3 country code. type: string postCode: description: Postal code. type: string town: description: Town or city name. type: string street: description: Street name. type: string subStreet: description: Additional street information. type: string state: description: State name (if applicable). type: string buildingName: description: Building name (if applicable). type: string flatNumber: description: Flat or apartment number. type: string buildingNumber: description: Building number. type: string internalId: description: >- VASP ID for counterparty transaction. If provided, we trust the exchange and use the expected VASP for transaction approval. type: string paymentMethod: description: Information about the payment method. type: object properties: type: description: 'Payment method type: `card`/`account`/`crypto`.' type: string accountId: description: >- Representation of the account ID: Account number, IBAN or DC hash for `card`, crypto wallet address for `crypto` type etc. type: string issuingCountry: description: The payment issuing country code in Alpha-3 format. type: string 3dsUsed: description: Indication of 3d secure auth being used. type: boolean 2faUsed: description: Indication of 2fa being used. type: boolean device: description: Device information. type: object properties: userAgent: description: Device user agent. type: string sessionId: description: Transaction session identifier. type: string sessionAgeMs: description: Session lifetime in milliseconds. type: integer format: int64 acceptLang: description: From browser, e.g. `en`. type: string platform: description: Device platform, e.g. `Mobile Android`. type: string fingerprint: description: Device fingerprint. type: string address: description: Device address. type: object properties: country: description: Alpha-3 country code. type: string postCode: description: Postal code. type: string town: description: Town or city name. type: string street: description: Street name. type: string subStreet: description: Additional street information. type: string state: description: State name (if applicable). type: string buildingName: description: Building name (if applicable). type: string flatNumber: description: Flat or apartment number. type: string buildingNumber: description: Building number. type: string coords: description: Coordinates. type: object properties: lat: description: Position latitude in decimal degrees. type: number format: double lon: description: Position longitude in decimal degrees. type: number format: double accuracy: description: >- Accuracy of the latitude and longitude properties, expressed in meters. # type: string ipInfo: description: Data about used IP address. type: object properties: lat: description: Position latitude in decimal degrees. type: number format: double lon: description: Position longitude in decimal degrees. type: number format: double ip: description: IP address. type: string countryCode3: description: Country Alpha-3 code. type: string asn: description: ASN. type: integer format: int32 asnOrg: description: ASN organisation. type: string riskyAsn: description: ASN is risky or not. type: boolean counterparty: description: >- Transaction participant data (sender or remitter, depending on `info.direction`). type: object required: - externalUserId - fullName - type properties: externalUserId: 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. type: string fullName: description: Full name of the participant. type: string type: description: >- Participant entity type: `company` or `individual`. Set to `individual` by default. type: string default: individual address: description: Participant address. type: object properties: country: description: Alpha-3 country code. type: string postCode: description: Postal code. type: string town: description: Town or city name. type: string street: description: Street name. type: string subStreet: description: Additional street information. type: string state: description: State name (if applicable). type: string buildingName: description: Building name (if applicable). type: string flatNumber: description: Flat or apartment number. type: string buildingNumber: description: Building number. type: string institutionInfo: description: Transaction institution information type: object properties: code: description: Transaction institution code. type: string name: description: Transaction institution name. type: string address: description: Transaction institution address. type: object properties: country: description: Alpha-3 country code. type: string postCode: description: Postal code. type: string town: description: Town or city name. type: string street: description: Street name. type: string subStreet: description: Additional street information. type: string state: description: State name (if applicable). type: string buildingName: description: Building name (if applicable). type: string flatNumber: description: Flat or apartment number. type: string buildingNumber: description: Building number. type: string internalId: description: >- VASP ID for counterparty transaction. If provided, we trust the exchange and use the expected VASP for transaction approval. type: string paymentMethod: description: Information about the payment method. type: object properties: type: description: 'Payment method type: `card`/`account`/`crypto`.' type: string accountId: description: >- Representation of the account ID: Account number, IBAN or DC hash for `card`, crypto wallet address for `crypto` type etc. type: string issuingCountry: description: The payment issuing country code in Alpha-3 format. type: string 3dsUsed: description: Indication of 3d secure auth being used. type: boolean 2faUsed: description: Indication of 2fa being used. type: boolean device: description: Device information. type: object properties: userAgent: description: Device user agent. type: string sessionId: description: Transaction session identifier. type: string sessionAgeMs: description: Session lifetime in milliseconds. type: integer format: int64 acceptLang: description: From browser, e.g. `en`. type: string platform: description: Device platform, e.g. `Mobile Android`. type: string fingerprint: description: Device fingerprint. type: string address: description: Device address. type: object properties: country: description: Alpha-3 country code. type: string postCode: description: Postal code. type: string town: description: Town or city name. type: string street: description: Street name. type: string subStreet: description: Additional street information. type: string state: description: State name (if applicable). type: string buildingName: description: Building name (if applicable). type: string flatNumber: description: Flat or apartment number. type: string buildingNumber: description: Building number. type: string coords: description: Coordinates. type: object properties: lat: description: Position latitude in decimal degrees. type: number format: double lon: description: Position longitude in decimal degrees. type: number format: double accuracy: description: >- Accuracy of the latitude and longitude properties, expressed in meters. # type: string ipInfo: description: Data about used IP address. type: object properties: lat: description: Position latitude in decimal degrees. type: number format: double lon: description: Position longitude in decimal degrees. type: number format: double ip: description: IP address. type: string countryCode3: description: Country Alpha-3 code. type: string asn: description: ASN. type: integer format: int32 asnOrg: description: ASN organisation. type: string riskyAsn: description: ASN is risky or not. type: boolean type: description: >- A transaction type. Expects values:
  • finance(default)
  • gamblingBet
  • gamblingLimitChange
  • gamblingBonusChange
  • kyc
  • travelRule
  • userPlatformEvent
    • login
    • signup
    • passwordChange
    • twoFaReset
type: string default: finance sourceKey: description: A source key indication to separate access to transactions. type: string TransactionBulkImportRequest: type: object required: - applicantId - data properties: applicantId: description: >- A unique identification number of the applicant who passed user verification (KYC). type: string data: description: >- An object representing the transaction. For more information on the structure, see [Submit transaction for existing applicant](ref:submit-transaction-for-existing-applicant). type: object required: - txnId properties: info: description: Transaction information. type: object required: - direction - amount - currencyCode properties: direction: description: >- Can be `out` (applicant sends to counterparty) or `in` (counterparty sends to applicant). type: string amount: description: The amount of funds used in this transaction. type: number format: double amountInDefaultCurrency: 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. type: number format: double currencyType: description: Indicates whether the transaction is `crypto` or `fiat`. type: string currencyCode: description: Currency code (`USD`, `GBP`, `BTC`, etc). type: string cryptoParams: description: >- Includes crypto transaction parameters. It is crucial for Sumsub to understand which crypto chain is used to correctly utilize the data. type: object required: - attemptId properties: attemptId: description: Unique identifier of the transaction attempt. type: string outputIndex: description: An index number for a transaction output. type: integer format: int32 cryptoChain: 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). type: string paymentTxnId: description: >- Crypto transaction ID from the blockchain. Required for crypto check requests only. type: string paymentDetails: description: A comment with payment details. type: string type: description: >- Accepts any value that helps you categorize transactions. For example, for gambling transactions, you can specify `bonus`, `payroll`, or `cashback`. type: string txnId: description: A unique transaction identifier. type: string txnDate: description: >- Time when the transaction was initiated (format `yyyy-MM-dd HH:mm:ss+XXXX`, e.g. 2022-11-24 23:37:02+0000). type: string format: date props: description: >- Transaction properties. Map of strings - JSON of custom keys and string values. type: string applicant: description: >- Transaction participant data with mandatory `applicantId` (sender or remitter depending on `info.direction`). type: object required: - externalUserId - fullName - type properties: externalUserId: 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. type: string fullName: description: Full name of the participant. type: string type: description: >- Participant entity type: `company` or `individual`. Set to `individual` by default. type: string default: individual address: description: Participant address. type: object properties: country: description: Alpha-3 country code. type: string postCode: description: Postal code. type: string town: description: Town or city name. type: string street: description: Street name. type: string subStreet: description: Additional street information. type: string state: description: State name (if applicable). type: string buildingName: description: Building name (if applicable). type: string flatNumber: description: Flat or apartment number. type: string buildingNumber: description: Building number. type: string institutionInfo: description: Transaction institution information type: object properties: code: description: Transaction institution code. type: string name: description: Transaction institution name. type: string address: description: Transaction institution address. type: object properties: country: description: Alpha-3 country code. type: string postCode: description: Postal code. type: string town: description: Town or city name. type: string street: description: Street name. type: string subStreet: description: Additional street information. type: string state: description: State name (if applicable). type: string buildingName: description: Building name (if applicable). type: string flatNumber: description: Flat or apartment number. type: string buildingNumber: description: Building number. type: string internalId: description: >- VASP ID for counterparty transaction. If provided, we trust the exchange and use the expected VASP for transaction approval. type: string paymentMethod: description: Information about the payment method. type: object properties: type: description: 'Payment method type: `card`/`account`/`crypto`.' type: string accountId: description: >- Representation of the account ID: Account number, IBAN or DC hash for `card`, crypto wallet address for `crypto` type etc. type: string issuingCountry: description: The payment issuing country code in Alpha-3 format. type: string 3dsUsed: description: Indication of 3d secure auth being used. type: boolean 2faUsed: description: Indication of 2fa being used. type: boolean device: description: Device information. type: object properties: userAgent: description: Device user agent. type: string sessionId: description: Transaction session identifier. type: string sessionAgeMs: description: Session lifetime in milliseconds. type: integer format: int64 acceptLang: description: From browser, e.g. `en`. type: string platform: description: Device platform, e.g. `Mobile Android`. type: string fingerprint: description: Device fingerprint. type: string address: description: Device address. type: object properties: country: description: Alpha-3 country code. type: string postCode: description: Postal code. type: string town: description: Town or city name. type: string street: description: Street name. type: string subStreet: description: Additional street information. type: string state: description: State name (if applicable). type: string buildingName: description: Building name (if applicable). type: string flatNumber: description: Flat or apartment number. type: string buildingNumber: description: Building number. type: string coords: description: Coordinates. type: object properties: lat: description: Position latitude in decimal degrees. type: number format: double lon: description: Position longitude in decimal degrees. type: number format: double accuracy: description: >- Accuracy of the latitude and longitude properties, expressed in meters. # type: string ipInfo: description: Data about used IP address. type: object properties: lat: description: Position latitude in decimal degrees. type: number format: double lon: description: Position longitude in decimal degrees. type: number format: double ip: description: IP address. type: string countryCode3: description: Country Alpha-3 code. type: string asn: description: ASN. type: integer format: int32 asnOrg: description: ASN organisation. type: string riskyAsn: description: ASN is risky or not. type: boolean counterparty: description: >- Transaction participant data (sender or remitter depending on `info.direction`). type: object required: - externalUserId - fullName - type properties: externalUserId: 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. type: string fullName: description: Full name of the participant. type: string type: description: >- Participant entity type: `company` or `individual`. Set to `individual` by default. type: string default: individual address: description: Participant address. type: object properties: country: description: Alpha-3 country code. type: string postCode: description: Postal code. type: string town: description: Town or city name. type: string street: description: Street name. type: string subStreet: description: Additional street information. type: string state: description: State name (if applicable). type: string buildingName: description: Building name (if applicable). type: string flatNumber: description: Flat or apartment number. type: string buildingNumber: description: Building number. type: string institutionInfo: description: Transaction institution information type: object properties: code: description: Transaction institution code. type: string name: description: Transaction institution name. type: string address: description: Transaction institution address. type: object properties: country: description: Alpha-3 country code. type: string postCode: description: Postal code. type: string town: description: Town or city name. type: string street: description: Street name. type: string subStreet: description: Additional street information. type: string state: description: State name (if applicable). type: string buildingName: description: Building name (if applicable). type: string flatNumber: description: Flat or apartment number. type: string buildingNumber: description: Building number. type: string internalId: description: >- VASP ID for counterparty transaction. If provided, we trust the exchange and use the expected VASP for transaction approval. type: string paymentMethod: description: Information about the payment method. type: object properties: type: description: 'Payment method type: `card`/`account`/`crypto`.' type: string accountId: description: >- Representation of the account ID: Account number, IBAN or DC hash for `card`, crypto wallet address for `crypto` type etc. type: string issuingCountry: description: The payment issuing country code in Alpha-3 format. type: string 3dsUsed: description: Indication of 3d secure auth being used. type: boolean 2faUsed: description: Indication of 2fa being used. type: boolean device: description: Device information. type: object properties: userAgent: description: Device user agent. type: string sessionId: description: Transaction session identifier. type: string sessionAgeMs: description: Session lifetime in milliseconds. type: integer format: int64 acceptLang: description: From browser, e.g. `en`. type: string platform: description: Device platform, e.g. `Mobile Android`. type: string fingerprint: description: Device fingerprint. type: string address: description: Device address. type: object properties: country: description: Alpha-3 country code. type: string postCode: description: Postal code. type: string town: description: Town or city name. type: string street: description: Street name. type: string subStreet: description: Additional street information. type: string state: description: State name (if applicable). type: string buildingName: description: Building name (if applicable). type: string flatNumber: description: Flat or apartment number. type: string buildingNumber: description: Building number. type: string coords: description: Coordinates. type: object properties: lat: description: Position latitude in decimal degrees. type: number format: double lon: description: Position longitude in decimal degrees. type: number format: double accuracy: description: >- Accuracy of the latitude and longitude properties, expressed in meters. # type: string ipInfo: description: Data about used IP address. type: object properties: lat: description: Position latitude in decimal degrees. type: number format: double lon: description: Position longitude in decimal degrees. type: number format: double ip: description: IP address. type: string countryCode3: description: Country Alpha-3 code. type: string asn: description: ASN. type: integer format: int32 asnOrg: description: ASN organisation. type: string riskyAsn: description: ASN is risky or not. type: boolean type: description: >- Transaction type. Takes predefined values: `finance`/`gamblingBet`/`gamblingLimitChange`/`kyc`/`login`/`signup`/`passwordChange`/`twoFaReset`/`travelRule` (`finance` by default). type: string sourceKey: description: Source Key indication to separate accesses to transactions. type: string TransactionBulkImportRequest1: type: object required: - applicantId - data properties: applicantId: description: >- A unique identification number of the applicant who passed user verification (KYC). type: string data: description: >- An object representing the transaction. For more information on the structure, see [Submit transaction for existing applicant](ref:submit-transaction-for-existing-applicant). type: object required: - txnId properties: info: description: Transaction information. type: object required: - direction - amount - currencyCode properties: direction: description: >- Can be `out` (applicant sends to counterparty) or `in` (counterparty sends to applicant). type: string amount: description: The amount of funds used in this transaction. type: number format: double amountInDefaultCurrency: 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. type: number format: double currencyType: description: Indicates whether the transaction is `crypto` or `fiat`. type: string currencyCode: description: Currency code (`USD`, `GBP`, `BTC`, etc). type: string cryptoParams: description: >- Includes crypto transaction parameters. It is crucial for Sumsub to understand which crypto chain is used to correctly utilize the data. type: object required: - attemptId properties: attemptId: description: Unique identifier of the transaction attempt. type: string outputIndex: description: An index number for a transaction output. type: integer format: int32 cryptoChain: 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). type: string paymentTxnId: description: >- Crypto transaction ID from the blockchain. Required for crypto check requests only. type: string paymentDetails: description: A comment with payment details. type: string type: description: >- Accepts any value that helps you categorize transactions. For example, for gambling transactions, you can specify `bonus`, `payroll`, or `cashback`. type: string txnId: description: A unique transaction identifier. type: string txnDate: description: >- Time when the transaction was initiated (format `yyyy-MM-dd HH:mm:ss+XXXX`, e.g. 2022-11-24 23:37:02+0000). type: string format: date props: description: >- Transaction properties. Map of strings - JSON of custom keys and string values. type: string applicant: description: >- Transaction participant data with mandatory `applicantId` (sender or remitter depending on `info.direction`). type: object required: - externalUserId - fullName - type properties: externalUserId: 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. type: string fullName: description: Full name of the participant. type: string type: description: >- Participant entity type: `company` or `individual`. Set to `individual` by default. type: string default: individual address: description: Participant address. type: object properties: country: description: Alpha-3 country code. type: string postCode: description: Postal code. type: string town: description: Town or city name. type: string street: description: Street name. type: string subStreet: description: Additional street information. type: string state: description: State name (if applicable). type: string buildingName: description: Building name (if applicable). type: string flatNumber: description: Flat or apartment number. type: string buildingNumber: description: Building number. type: string institutionInfo: description: Transaction institution information type: object properties: code: description: Transaction institution code. type: string name: description: Transaction institution name. type: string address: description: Transaction institution address. type: object properties: country: description: Alpha-3 country code. type: string postCode: description: Postal code. type: string town: description: Town or city name. type: string street: description: Street name. type: string subStreet: description: Additional street information. type: string state: description: State name (if applicable). type: string buildingName: description: Building name (if applicable). type: string flatNumber: description: Flat or apartment number. type: string buildingNumber: description: Building number. type: string internalId: description: >- VASP ID for counterparty transaction. If provided, we trust the exchange and use the expected VASP for transaction approval. type: string paymentMethod: description: Information about the payment method. type: object properties: type: description: 'Payment method type: `card`/`account`/`crypto`.' type: string accountId: description: >- Representation of the account ID: Account number, IBAN or DC hash for `card`, crypto wallet address for `crypto` type etc. type: string issuingCountry: description: The payment issuing country code in Alpha-3 format. type: string 3dsUsed: description: Indication of 3d secure auth being used. type: boolean 2faUsed: description: Indication of 2fa being used. type: boolean device: description: Device information. type: object properties: userAgent: description: Device user agent. type: string sessionId: description: Transaction session identifier. type: string sessionAgeMs: description: Session lifetime in milliseconds. type: integer format: int64 acceptLang: description: From browser, e.g. `en`. type: string platform: description: Device platform, e.g. `Mobile Android`. type: string fingerprint: description: Device fingerprint. type: string address: description: Device address. type: object properties: country: description: Alpha-3 country code. type: string postCode: description: Postal code. type: string town: description: Town or city name. type: string street: description: Street name. type: string subStreet: description: Additional street information. type: string state: description: State name (if applicable). type: string buildingName: description: Building name (if applicable). type: string flatNumber: description: Flat or apartment number. type: string buildingNumber: description: Building number. type: string coords: description: Coordinates. type: object properties: lat: description: Position latitude in decimal degrees. type: number format: double lon: description: Position longitude in decimal degrees. type: number format: double accuracy: description: >- Accuracy of the latitude and longitude properties, expressed in meters. # type: string ipInfo: description: Data about used IP address. type: object properties: lat: description: Position latitude in decimal degrees. type: number format: double lon: description: Position longitude in decimal degrees. type: number format: double ip: description: IP address. type: string countryCode3: description: Country Alpha-3 code. type: string asn: description: ASN. type: integer format: int32 asnOrg: description: ASN organisation. type: string riskyAsn: description: ASN is risky or not. type: boolean counterparty: description: >- Transaction participant data (sender or remitter depending on `info.direction`). type: object required: - externalUserId - fullName - type properties: externalUserId: 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. type: string fullName: description: Full name of the participant. type: string type: description: >- Participant entity type: `company` or `individual`. Set to `individual` by default. type: string default: individual address: description: Participant address. type: object properties: country: description: Alpha-3 country code. type: string postCode: description: Postal code. type: string town: description: Town or city name. type: string street: description: Street name. type: string subStreet: description: Additional street information. type: string state: description: State name (if applicable). type: string buildingName: description: Building name (if applicable). type: string flatNumber: description: Flat or apartment number. type: string buildingNumber: description: Building number. type: string institutionInfo: description: Transaction institution information type: object properties: code: description: Transaction institution code. type: string name: description: Transaction institution name. type: string address: description: Transaction institution address. type: object properties: country: description: Alpha-3 country code. type: string postCode: description: Postal code. type: string town: description: Town or city name. type: string street: description: Street name. type: string subStreet: description: Additional street information. type: string state: description: State name (if applicable). type: string buildingName: description: Building name (if applicable). type: string flatNumber: description: Flat or apartment number. type: string buildingNumber: description: Building number. type: string internalId: description: >- VASP ID for counterparty transaction. If provided, we trust the exchange and use the expected VASP for transaction approval. type: string paymentMethod: description: Information about the payment method. type: object properties: type: description: 'Payment method type: `card`/`account`/`crypto`.' type: string accountId: description: >- Representation of the account ID: Account number, IBAN or DC hash for `card`, crypto wallet address for `crypto` type etc. type: string issuingCountry: description: The payment issuing country code in Alpha-3 format. type: string 3dsUsed: description: Indication of 3d secure auth being used. type: boolean 2faUsed: description: Indication of 2fa being used. type: boolean device: description: Device information. type: object properties: userAgent: description: Device user agent. type: string sessionId: description: Transaction session identifier. type: string sessionAgeMs: description: Session lifetime in milliseconds. type: integer format: int64 acceptLang: description: From browser, e.g. `en`. type: string platform: description: Device platform, e.g. `Mobile Android`. type: string fingerprint: description: Device fingerprint. type: string address: description: Device address. type: object properties: country: description: Alpha-3 country code. type: string postCode: description: Postal code. type: string town: description: Town or city name. type: string street: description: Street name. type: string subStreet: description: Additional street information. type: string state: description: State name (if applicable). type: string buildingName: description: Building name (if applicable). type: string flatNumber: description: Flat or apartment number. type: string buildingNumber: description: Building number. type: string coords: description: Coordinates. type: object properties: lat: description: Position latitude in decimal degrees. type: number format: double lon: description: Position longitude in decimal degrees. type: number format: double accuracy: description: >- Accuracy of the latitude and longitude properties, expressed in meters. # type: string ipInfo: description: Data about used IP address. type: object properties: lat: description: Position latitude in decimal degrees. type: number format: double lon: description: Position longitude in decimal degrees. type: number format: double ip: description: IP address. type: string countryCode3: description: Country Alpha-3 code. type: string asn: description: ASN. type: integer format: int32 asnOrg: description: ASN organisation. type: string riskyAsn: description: ASN is risky or not. type: boolean type: description: >- Transaction type. Takes predefined values: `finance`/`gamblingBet`/`gamblingLimitChange`/`kyc`/`login`/`signup`/`passwordChange`/`twoFaReset`/`travelRule` (`finance` by default). type: string sourceKey: description: Source Key indication to separate accesses to transactions. type: string TransactionUpdatePropertiesRequest: type: object required: - customProperty properties: customProperty: type: string default: newValue TransactionUpdatePropertiesRequest1: type: object required: - customProperty properties: customProperty: type: string default: newValue TransactionApproveRejectRequest: type: object properties: reviewAnswer: description: Sets the review answer. Can be `GREEN` or `RED`. type: string TransactionApproveRejectRequest1: type: object properties: reviewAnswer: description: Sets the review answer. Can be `GREEN` or `RED`. type: string TransactionRemoveTagsRequest: type: object properties: RAW_BODY: description: Tags to remove. Case-sensitive. type: array items: type: string TransactionRemoveTagsRequest1: type: object properties: RAW_BODY: description: Tags to remove. Case-sensitive. type: array items: type: string TagAddTransactionTagsRequest: type: object properties: RAW_BODY: description: Tags to add. Case-sensitive. type: array items: type: string TagAddTransactionTagsRequest1: type: object properties: RAW_BODY: description: Tags to add. Case-sensitive. type: array items: type: string NoteRemoveFromTransactionRequest: type: object required: - txnId - id properties: txnId: description: A unique transaction identifier. type: string id: description: A unique note identifier. type: string NoteRemoveFromTransactionRequest1: type: object required: - txnId - id properties: txnId: description: A unique transaction identifier. type: string id: description: A unique note identifier. type: string NoteUpdateTransactionNotesRequest: type: object required: - txnId - id - note properties: tags: description: >- [Tags](https://docs.sumsub.com/reference) that you may want to assign. type: array items: type: string txnId: description: A unique transaction identifier. type: string id: description: A unique note identifier. type: string note: description: A new note. type: string NoteUpdateTransactionNotesRequest1: type: object required: - txnId - id - note properties: tags: description: >- [Tags](https://docs.sumsub.com/reference) that you may want to assign. type: array items: type: string txnId: description: A unique transaction identifier. type: string id: description: A unique note identifier. type: string note: description: A new note. type: string NoteAddToTransactionRequest: type: object required: - txnId - note properties: tags: description: >- [Tags](https://docs.sumsub.com/reference) that you may want to assign. type: array items: type: string txnId: description: A unique transaction identifier. type: string note: description: A note to add. type: string NoteAddToTransactionRequest1: type: object required: - txnId - note properties: tags: description: >- [Tags](https://docs.sumsub.com/reference) that you may want to assign. type: array items: type: string txnId: description: A unique transaction identifier. type: string note: description: A note to add. type: string TransactionUpdateBlockchainInfoRequest: type: object properties: fingerprint: description: A crypto transaction ID received from the blockchain. type: string TransactionUpdateBlockchainInfoRequest1: type: object properties: fingerprint: description: A crypto transaction ID received from the blockchain. type: string ApplicantEnrichTransactionWithTravelRuleDataRequest: type: object required: - fullName properties: fullName: description: Participant full name. type: string ApplicantEnrichTransactionWithTravelRuleDataRequest1: type: object required: - fullName properties: fullName: description: Participant full name. type: string AccessTokenGenerateFishermanTokenRequest: type: object required: - sessionId - userPlatformEventType properties: sessionId: description: A unique identifier of the applicant session. type: string userPlatformEventType: description: >- An event that occurred on the applicant device as a result of the interaction with the application UI.

The following event types are supported:
  • login — applicant logging in.
  • signup — applicant signing up.
  • passwordReset — applicant resetting the password.
  • twoFaReset — applicant resetting two-factor authentication.
type: string ttlInSecs: description: A lifespan of a token in seconds. Default value is 1800 seconds. type: integer default: 1800 format: int32 AccessTokenGenerateFishermanTokenRequest1: type: object required: - sessionId - userPlatformEventType properties: sessionId: description: A unique identifier of the applicant session. type: string userPlatformEventType: description: >- An event that occurred on the applicant device as a result of the interaction with the application UI.

The following event types are supported:
  • login — applicant logging in.
  • signup — applicant signing up.
  • passwordReset — applicant resetting the password.
  • twoFaReset — applicant resetting two-factor authentication.
type: string ttlInSecs: description: A lifespan of a token in seconds. Default value is 1800 seconds. type: integer default: 1800 format: int32 AccessTokenConfirmPlatformEventRequest: type: object required: - applicant - userPlatformEventInfo - txnId properties: applicant: description: Applicant's full name and identifier on your side. type: object required: - fullName - externalUserId properties: fullName: description: Full name of the applicant. type: string externalUserId: description: A unique applicant identifier within your system. type: string userPlatformEventInfo: description: >- Indicates the applicant platform event status. Can be omitted if the event was successful. type: object properties: failure: description: >- Indicates whether the event on the applicant side was successful or not.
  • true — event failed (e.g. wrong credentials provided when logging in, or incorrect data submitted when resetting password).
  • false — event was successful.
type: boolean txnId: description: >- Unique identifier for the confirmed applicant platform event that you generate on your side. type: string AccessTokenConfirmPlatformEventRequest1: type: object required: - applicant - userPlatformEventInfo - txnId properties: applicant: description: Applicant's full name and identifier on your side. type: object required: - fullName - externalUserId properties: fullName: description: Full name of the applicant. type: string externalUserId: description: A unique applicant identifier within your system. type: string userPlatformEventInfo: description: >- Indicates the applicant platform event status. Can be omitted if the event was successful. type: object properties: failure: description: >- Indicates whether the event on the applicant side was successful or not.
  • true — event failed (e.g. wrong credentials provided when logging in, or incorrect data submitted when resetting password).
  • false — event was successful.
type: boolean txnId: description: >- Unique identifier for the confirmed applicant platform event that you generate on your side. type: string ApplicantGetDataResponse: oneOf: - title: Individual applicants type: object properties: info: type: object properties: firstName: type: string example: CHRISTIAN firstNameEn: type: string example: CHRISTIAN lastName: type: string example: SMITH lastNameEn: type: string example: SMITH dob: type: string example: '1989-07-16' country: type: string example: DEU idDocs: type: array items: type: object properties: idDocType: type: string example: ID_CARD country: type: string example: DEU firstName: type: string example: CHRISTIAN firstNameEn: type: string example: CHRISTIAN lastName: type: string example: SMITH lastNameEn: type: string example: SMITH validUntil: type: string example: '2028-09-04' number: type: string example: LGXX359T8 dob: type: string example: '1989-07-16' mrzLine1: type: string example: IDD<- By clicking Next, I accept [the Terms and Conditions](https://www.sumsub.com/consent-to-personal-data-processing/) email: type: string example: christman1@gmail.com applicantPlatform: type: string example: Android requiredIdDocs: type: object properties: docSets: type: array items: type: object properties: idDocSetType: type: string example: IDENTITY types: type: array items: type: string example: PASSPORT review: type: object properties: elapsedSincePendingMs: type: integer example: 115879 default: 0 elapsedSinceQueuedMs: type: integer example: 95785 default: 0 reprocessing: type: boolean example: true default: true levelName: type: string example: basic-kyc createDate: type: string example: 2020-06-24 05:11:02+0000 reviewDate: type: string example: 2020-06-24 05:12:58+0000 reviewResult: type: object properties: reviewAnswer: type: string example: GREEN reviewStatus: type: string example: completed lang: type: string example: de type: type: string example: individual - title: Company applicants type: object properties: info: type: object properties: companyInfo: type: object properties: companyName: type: string example: SUMSUB LIMITED registrationNumber: type: string example: '1555555' country: type: string example: GBR incorporatedOn: type: string example: '2018-02-28 00:00:00' type: type: string example: ltd website: type: string example: www.sumsub.com beneficiaries: type: array items: type: object properties: applicantId: type: string example: 5ecfbecad5ea48743f8dd438 positions: type: array items: type: string example: director type: type: string example: ubo inRegistry: type: boolean example: false default: true imageIds: {} applicant: {} id: type: string example: 5ecfbe9ad5ea48743f8dd1b8 createdAt: type: string example: '2020-05-28 13:37:30' clientId: type: string example: coolclientid inspectionId: type: string example: 5ecfbe9ad5ea48743f8dd1b9 externalUserId: type: string example: externalCompanyId requiredIdDocs: type: object properties: docSets: type: array items: type: object properties: idDocSetType: type: string example: COMPANY types: type: array items: type: string example: COMPANY_DOC steps: type: array items: type: object properties: name: type: string example: company minDocsCnt: type: integer example: 1 default: 0 idDocTypes: type: array items: type: string example: COMPANY_DOC idDocSubTypes: {} review: type: object properties: elapsedSincePendingMs: type: integer example: 308656 default: 0 elapsedSinceQueuedMs: type: integer example: 26993 default: 0 reprocessing: type: boolean example: true default: true createDate: type: string example: 2020-05-29 12:22:11+0000 reviewDate: type: string example: 2020-05-29 12:27:19+0000 startDate: type: string example: 2020-05-29 12:26:52+0000 reviewResult: type: object properties: reviewAnswer: type: string example: GREEN reviewStatus: type: string example: completed lang: type: string example: en type: type: string example: company ApplicantGetDataByExternalUserIdResponse: oneOf: - title: Individual applicants type: object properties: info: type: object properties: firstName: type: string example: CHRISTIAN firstNameEn: type: string example: CHRISTIAN lastName: type: string example: SMITH lastNameEn: type: string example: SMITH dob: type: string example: '1989-07-16' country: type: string example: DEU idDocs: type: array items: type: object properties: idDocType: type: string example: ID_CARD country: type: string example: DEU firstName: type: string example: CHRISTIAN firstNameEn: type: string example: CHRISTIAN lastName: type: string example: SMITH lastNameEn: type: string example: SMITH validUntil: type: string example: '2028-09-04' number: type: string example: LGXX359T8 dob: type: string example: '1989-07-16' mrzLine1: type: string example: IDD<- By clicking Next, I accept [the Terms and Conditions](https://www.sumsub.com/consent-to-personal-data-processing/) email: type: string example: christman1@gmail.com applicantPlatform: type: string example: Android requiredIdDocs: type: object properties: docSets: type: array items: type: object properties: idDocSetType: type: string example: IDENTITY types: type: array items: type: string example: PASSPORT review: type: object properties: elapsedSincePendingMs: type: integer example: 115879 default: 0 elapsedSinceQueuedMs: type: integer example: 95785 default: 0 reprocessing: type: boolean example: true default: true levelName: type: string example: basic-kyc createDate: type: string example: 2020-06-24 05:11:02+0000 reviewDate: type: string example: 2020-06-24 05:12:58+0000 reviewResult: type: object properties: reviewAnswer: type: string example: GREEN reviewStatus: type: string example: completed lang: type: string example: de type: type: string example: individual - title: Company applicants type: object properties: info: type: object properties: companyInfo: type: object properties: companyName: type: string example: SUMSUB LIMITED registrationNumber: type: string example: '1555555' country: type: string example: GBR incorporatedOn: type: string example: '2018-02-28 00:00:00' type: type: string example: ltd website: type: string example: www.sumsub.com beneficiaries: type: array items: type: object properties: applicantId: type: string example: 5ecfbecad5ea48743f8dd438 positions: type: array items: type: string example: director type: type: string example: ubo inRegistry: type: boolean example: false default: true imageIds: {} applicant: {} id: type: string example: 5ecfbe9ad5ea48743f8dd1b8 createdAt: type: string example: '2020-05-28 13:37:30' clientId: type: string example: coolclientid inspectionId: type: string example: 5ecfbe9ad5ea48743f8dd1b9 externalUserId: type: string example: externalCompanyId requiredIdDocs: type: object properties: docSets: type: array items: type: object properties: idDocSetType: type: string example: COMPANY types: type: array items: type: string example: COMPANY_DOC steps: type: array items: type: object properties: name: type: string example: company minDocsCnt: type: integer example: 1 default: 0 idDocTypes: type: array items: type: string example: COMPANY_DOC idDocSubTypes: {} review: type: object properties: elapsedSincePendingMs: type: integer example: 308656 default: 0 elapsedSinceQueuedMs: type: integer example: 26993 default: 0 reprocessing: type: boolean example: true default: true createDate: type: string example: 2020-05-29 12:22:11+0000 reviewDate: type: string example: 2020-05-29 12:27:19+0000 startDate: type: string example: 2020-05-29 12:26:52+0000 reviewResult: type: object properties: reviewAnswer: type: string example: GREEN reviewStatus: type: string example: completed lang: type: string example: en type: type: string example: company ApplicantCreatePaymentSourceActionsResponse: type: object properties: id: type: string example: 65e9624496bed30142a6d15c createdAt: type: string example: '2024-03-07 06:44:24' key: type: string example: SBCJVLAAMRHYAB clientId: type: string example: client_id externalActionId: type: string example: payment-source-1fbH9AYHn applicantId: type: string example: 65e881a212b4ef468def3bbb review: type: object properties: reviewId: type: string example: RlWfu attemptId: type: string example: dhABq attemptCnt: type: integer example: 0 default: 0 levelName: type: string example: paymentSource createDate: type: string example: 2024-03-07 06:44:24+0000 reviewStatus: type: string example: init requiredIdDocs: type: object properties: docSets: type: array items: type: object properties: idDocSetType: type: string example: PAYMENT_METHODS types: type: array items: type: string example: PAYMENT_SOURCE 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: institutionName: type: string example: Name fullName: type: string example: John Doe accountIdentifier: type: string example: '120834387' email: type: string example: JohnDoe@mail.com type: type: string example: paymentMethod TransactionUpdateBlockchainInfoResponse: type: object properties: {} ApplicantMoveTransactionToAnotherApplicantResponse: type: object properties: {} ApplicantEnrichTransactionWithTravelRuleDataResponse: type: object properties: {} VaspGetAvailableVaspsResponse: type: object properties: {} VaspGetAvailableVasps400Response: type: object properties: {} security: - sec0: [] x-readme: headers: [] explorer-enabled: true proxy-enabled: true x-readme-fauxas: true _id: 64562b6dd507c500683094e9:6602995fbcddd70025062118