--- updatedAt: 2026-09-18T13:25:59.000Z agentTools: projectIndex: https://docs.sumsub.com/llms.txt --- # Submit transactions in bulk # Overview Use this method to import the list of transactions. The method expects transactions to be uploaded as a valid `NDJSON` file with the `Content-Type: application/x-ndjson` header. The request body must contain a sequence of JSON objects, each representing a single transaction, separated by newline characters (`\n`) as shown in the [examples below](#request-examples). > You can use the following templates as a reference: > > * [Template for existing applicants](https://sumsub.com/files/testdata-existing-applicant.ndjson) > * [Template for non-existing applicants](https://sumsub.com/files/testdata-non-existing-applicant.ndjson) ### Attention - This method is not intended for importing historical transactions. Use [Import transaction history](https://docs.sumsub.com/sumsub/reference/import-transaction-history) instead. - Import is limited to 1000 records per session. - Duplicate transactions are ignored. # Required permissions To use this method: * Your [app token](https://docs.sumsub.com/sumsub/docs/app-tokens) must have the **Manage TM transactions - Decisions** [permission](https://docs.sumsub.com/sumsub/docs/user-roles#permissions). * Your account must have Transaction Monitoring enabled in some form (for example, KYT scoring, Travel Rule, Device Intelligence, or one of the supported crypto risk-scoring providers). Both conditions are required — missing the permission, or having no TM feature enabled, returns a `403 Forbidden`. If neither feature is enabled for your account, contact your CSM or Sumsub support. ## Request examples ```curl Common example curl -X POST \ 'https://api.sumsub.com/resources/kyt/misc/txns/import' \ -H 'Content-Type: application/x-ndjson' \ -H 'X-App-Token: ' \ -H 'X-App-Access-Sig: ' \ -H 'X-App-Access-Ts: ' \ -d $'{ "applicantId": "636cee6b17d6c7000144673b", "data": { "txnId": "631f268442d8290001e1eee8_newTxn", "applicant": { "externalUserId": "uniqueRemitterId", "address": { "country": "DEU", "street": "Chauseestr. 60", "postCode": "101115", "town": "Berlin" }, "device": { "ipInfo": { "ip": "87.141.63.130" } }, "institutionInfo": { "code": "DEUTDEDB101", "name": "Deutsche Bank" } }, "counterparty": { "externalUserId": "uniqueBeneficiaryId", "fullName": "John Smith", "fullNameEn": "John Smith", "type": "individual", "institutionInfo": { "code": "CRESCHZZXXX", "name": "Credit Swiss (Schweiz)" } }, "info": { "direction": "in", "amount": 101.42, "currencyCode": "GBP", "paymentDetails": "Birthday Present" } } }\n{ "applicantId": "636cee6b17d6c7000144673b", "data": { "txnId": "631f268442d8290001e1eee9_newTxn", "applicant": { "externalUserId": "uniqueRemitterId", "address": { "country": "DEU", "street": "Chauseestr. 60", "postCode": "101115", "town": "Berlin" }, "institutionInfo": { "code": "DEUTDEDB101", "name": "Deutsche Bank" } }, "counterparty": { "externalUserId": "uniqueBeneficiaryId", "fullName": "John Smith", "fullNameEn": "John Smith", "type": "individual" }, "info": { "direction": "out", "amount": 101.42, "currencyCode": "GBP", "paymentDetails": "Birthday Present" } } }' ``` ```curl Example with tags and review curl -X POST \ 'https://api.sumsub.com/resources/kyt/misc/txns/importHistory' \ -H 'Content-Type: application/x-ndjson' \ -H 'X-App-Token: ' \ -H 'X-App-Access-Sig: ' \ -H 'X-App-Access-Ts: ' \ -d $'{ "applicantId": "636cee6b17d6c7000144673b", "data": { "txnId": "631f268442d8290001e1eee8_newTxn", "applicant": { "externalUserId": "uniqueRemitterId", "address": { "country": "DEU", "street": "Chauseestr. 60", "postCode": "101115", "town": "Berlin" }, "device": { "ipInfo": { "ip": "87.141.63.130" } }, "institutionInfo": { "code": "DEUTDEDB101", "name": "Deutsche Bank" } }, "counterparty": { "externalUserId": "uniqueBeneficiaryId", "fullName": "John Smith", "type": "individual", "institutionInfo": { "code": "CRESCHZZXXX", "name": "Credit Swiss (Schweiz)" } }, "info": { "direction": "in", "amount": 101.42, "currencyCode": "GBP", "paymentDetails": "Birthday Present" } }, "review": { "reviewResult": { "reviewAnswer": "GREEN" }, "reviewStatus": "completed" }, "tags": [ "test tag", "test tag 2" ] }\n{ "applicantId": "636cee6b17d6c7000144673b", "data": { "txnId": "631f268442d8290001e1eee9_newTxn", "applicant": { "externalUserId": "uniqueRemitterId", "address": { "country": "DEU", "street": "Chauseestr. 60", "postCode": "101115", "town": "Berlin" }, "institutionInfo": { "code": "DEUTDEDB101", "name": "Deutsche Bank" } }, "counterparty": { "externalUserId": "uniqueBeneficiaryId", "fullName": "John Smith", "type": "individual" }, "info": { "direction": "out", "amount": 101.42, "currencyCode": "GBP", "paymentDetails": "Birthday Present" } }, "review": { "reviewStatus": "onHold" }, "tags": [ "test tag", "test tag 2" ] }' ``` # Response explained If the request is successfully sent and processed, you will get a response indicating the number of bets successfully processed. **Response example to successful request:** ```json { "createdCnt": 2 } ``` If the request fails, you will receive an HTTP response containing an error code along with a message explaining the error. **Response example to failed request:** ```json { "code": 400, "correlationId": "c9eab02f4e77c2385866a77a105cb48a", "description": "Can't parse lines 1, first error: data.applicant: must not be null, data.txnId: must not be null" } ``` # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "sumsub-api", "version": "1.0" }, "servers": [ { "url": "https://api.sumsub.com" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "name": "X-App-Token", "in": "header", "x-default": "" } } }, "security": [ { "sec0": [] } ], "paths": { "/resources/kyt/misc/txns/import": { "post": { "summary": "Submit transactions in bulk", "description": "", "operationId": "bulk-transaction-import", "parameters": [ { "name": "Content-Type", "in": "header", "required": true, "schema": { "type": "string", "default": "application/x-ndjson" } }, { "name": "ignoreErrors", "in": "query", "description": "
  • true — all valid transactions will be created and returned, errors will be ignored during the processing and listed in the response.
  • false (default) — valid transactions will be created up to the first detected error. The response will only contain the error on which the processing was interrupted.
", "schema": { "type": "boolean", "default": false } }, { "name": "scoreSavedTxns", "in": "query", "description": "Allows you to control whether scoring should be run on imported transactions or not:
  • true (default) — start scoring after import.
  • false — do not start scoring after import.
", "schema": { "type": "boolean", "default": true } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "applicantId", "data" ], "properties": { "applicantId": { "type": "string", "description": "Unique identifier of the applicant who passed user verification (KYC) in the Sumsub system.

This identifier is a random combination of 24 digits and lowercase Latin characters. It is automatically generated when the applicant is created on the Sumsub side, and can be found in the [Dashboard](https://cockpit.sumsub.com/checkus/#/applicants/individual?limit=10&page=0).

If the `applicantId` is unknown to you, use the [Get applicant data (externalUserId)](https://docs.sumsub.com/sumsub/reference/get-applicant-data-via-externaluserid) method to fetch it." }, "data": { "type": "object", "description": "Object that represents the transaction. For more information on the structure, see [this article](https://docs.sumsub.com/sumsub/reference/get-transaction#response-explained).", "required": [ "txnId", "type" ], "properties": { "txnId": { "type": "string", "description": "Unique transaction identifier in your system (alphanumeric)." }, "txnDate": { "type": "string", "description": "Time when the transaction was initiated (format `yyyy-MM-dd HH:mm:ss+XXXX`, for example, `2022-11-24 23:37:02+0000`).

⚠️ `txnDate` must fall within the supported date range `1900-01-01` to `2299-12-31` (inclusive). A value outside this range is rejected with a `400` error. This field remains optional — omitting it (or sending `null`) is accepted.", "format": "date" }, "info": { "type": "object", "description": "Transaction information.", "required": [ "currencyType" ], "properties": { "direction": { "type": "string", "description": "
  • out — applicant sends to counterparty.
  • in — counterparty sends to applicant.
", "enum": [ "out", "in" ] }, "amount": { "type": "number", "description": "Amount of funds used in the transaction. Required for the `travelRule` and `finance` types of transaction.", "format": "double" }, "amountInDefaultCurrency": { "type": "number", "description": "Amount of funds used in the transaction in the default currency. For precise calculations, submit the converted default currency amount using this field.", "format": "double" }, "currencyType": { "type": "string", "description": "Transaction currency type: `crypto` or `fiat`." }, "currencyCode": { "type": "string", "description": "Currency code (for example, `USD`, `GBP`, `BTC`).

⚠️ Required for the `travelRule` and `finance` transaction types." }, "defaultCurrencyCode": { "type": "string", "description": "Code of the default currency (`USD`, `GBP`, `BTC`, etc)." }, "cryptoParams": { "type": "object", "description": "Includes crypto transaction parameters. It is crucial for Sumsub to understand which crypto chain is used to correctly utilize the data.", "properties": { "attemptId": { "type": "string", "description": "Unique identifier of the transaction attempt." }, "outputIndex": { "type": "integer", "description": "Index number for a transaction output.", "format": "int32" }, "cryptoChain": { "type": "string", "description": "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](https://docs.sumsub.com/sumsub/reference/crypto-chain-codes)." }, "contractAddress": { "type": "string", "description": "Smart-contract address of the token. Use this field to distinguish assets that share the same currencyCode and cryptoChain but represent different tokens." } } }, "paymentTxnId": { "type": "string", "description": "Unique identifier that is used to monitor a transaction in the blockchain. Used for `travelRule` transactions." }, "paymentDetails": { "type": "string", "description": "Remittance or payment reference information." }, "type": { "type": "string", "description": "String for categorizing transactions." }, "mcc": { "type": "string", "description": "4-digit number representing Merchant Category Code (MCC)." } } }, "props": { "type": "object", "description": "Map of strings in JSON format with custom keys and string values. Represents transaction properties.", "properties": { "customProperty": { "type": "string", "description": "If you want to add more custom properties, add as many key-value pairs to the request body as you need.

ⓘ `camelCase` for the property indicator is preferred (e.g., `customPropertyOne`)." }, "customPropertyTwo": { "type": "string" }, "customPropertyThree": { "type": "string" } } }, "applicant": { "type": "object", "description": "Transaction participant data with mandatory `applicantId` (sender or remitter depending on `info.direction`).", "required": [ "externalUserId" ], "properties": { "type": { "type": "string", "description": "Participant entity type.", "enum": [ "individual", "company" ] }, "externalUserId": { "type": "string", "description": "Unique identifier of the transaction participant (applicant or counterparty) on your side. 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." }, "fullName": { "type": "string", "description": "Full name of the participant. Required for the `company` type of applicant." }, "fullNameEn": { "type": "string", "description": "Participant’s full name transliterated in English. Use this field to provide an English version alongside the local-language name." }, "firstName": { "type": "string", "description": "First name of the participant." }, "firstNameEn": { "type": "string", "description": "Transliterated first name." }, "lastName": { "type": "string", "description": "Last name of the participant." }, "lastNameEn": { "type": "string", "description": "Transliterated last name." }, "nameType": { "type": "string", "description": "Name type.", "enum": [ "aliasName", "birthName", "maidenName", "legalName", "shortName", "tradingName", "other" ] }, "dob": { "type": "string", "description": "Date of birth.

⚠️ `dob` must fall within the supported date range `1900-01-01` to `2299-12-31` (inclusive). A value outside this range is rejected with a `400` error. This field remains optional — omitting it (or sending `null`) is accepted.", "format": "date" }, "placeOfBirth": { "type": "string", "description": "Place of birth. This can be a city, a town or another settlement type." }, "registrationDate": { "type": "string", "description": "Date and time when the applicant was initially registered in your system. Format: `YYYY-MM-DD hh:mm:ss` (for example, `2025-01-15 10:20:35`).", "format": "date-time" }, "address": { "type": "object", "description": "Participant address.", "properties": { "country": { "type": "string", "description": "Alpha-3 country code (for example, `DEU`, `GBR`, `ARG`, and so on)." }, "postCode": { "type": "string", "description": "Address postal code." }, "town": { "type": "string", "description": "The city, town, or another settlement." }, "street": { "type": "string", "description": "Street name." }, "subStreet": { "type": "string", "description": "Additional information related to the street. This could be a house number or any other details." }, "state": { "type": "string", "description": "The state, region, district, county or another territorial entity inside a country (if applicable)." }, "buildingName": { "type": "string", "description": "Building name (if applicable)." }, "flatNumber": { "type": "string", "description": "Flat or apartment number." }, "buildingNumber": { "type": "string", "description": "Building number." }, "formattedAddress": { "type": "string", "description": "Address in a human readable format. For example, `Design Offices, Philipsbornstraße 2, 30165 Hannover, Germany`." } } }, "device": { "type": "object", "description": "Device information.", "properties": { "userAgent": { "type": "string", "description": "String with the HTTP header that your web browser sends to each requested page. E.g. `Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_2) AppleWebKit/601.3.9 (KHTML, like Gecko) Version/9.0.2 Safari/601.3.9`." }, "sessionId": { "type": "string", "description": "Transaction session identifier (e.g. `r-v3-812412m9e12d42`)." }, "sessionAgeMs": { "type": "integer", "description": "Session lifetime in milliseconds.", "format": "int64" }, "acceptLang": { "type": "string", "description": "From browser, e.g. `en`." }, "fingerprint": { "type": "string", "description": "Device fingerprint." }, "address": { "type": "object", "description": "Device address.", "properties": { "country": { "type": "string", "description": "Alpha-3 country code (for example, `DEU`, `GBR`, `ARG`, and so on)." }, "postCode": { "type": "string", "description": "Address postal code." }, "town": { "type": "string", "description": "The city, town, or another settlement." }, "street": { "type": "string", "description": "Street name." }, "subStreet": { "type": "string", "description": "Additional information related to the street. This could be a house number or any other details." }, "state": { "type": "string", "description": "The state, region, district, county or another territorial entity inside a country (if applicable)." }, "buildingName": { "type": "string", "description": "Building name (if applicable)." }, "flatNumber": { "type": "string", "description": "Flat or apartment number." }, "buildingNumber": { "type": "string", "description": "Building number." }, "formattedAddress": { "type": "string", "description": "Address in a human readable format. For example, `Design Offices, Philipsbornstraße 2, 30165 Hannover, Germany`." } } }, "coords": { "type": "object", "description": "Coordinates.", "properties": { "lat": { "type": "number", "description": "Position latitude in decimal degrees.", "format": "double" }, "lon": { "type": "number", "description": "Position longitude in decimal degrees.", "format": "double" }, "accuracy": { "type": "string", "description": "Accuracy of the latitude and longitude properties, expressed in meters." } } }, "ipInfo": { "type": "object", "description": "Data about used IP address.", "properties": { "lat": { "type": "number", "description": "Position latitude in decimal degrees.", "format": "double" }, "lon": { "type": "number", "description": "Position longitude in decimal degrees.", "format": "double" }, "ip": { "type": "string", "description": "IP address." }, "countryCode3": { "type": "string", "description": "Country code (ISO 3166-1 alpha-3)." }, "asn": { "type": "integer", "description": "Autonomous System Number.", "format": "int32" }, "asnOrg": { "type": "string", "description": "ASN organisation." }, "riskyAsn": { "type": "boolean", "description": "Determines if the ASN is risky (`true`) or not (`false`)." } } } } }, "paymentMethod": { "type": "object", "description": "Information about the payment method.", "properties": { "type": { "type": "string", "description": "Payment method type.", "enum": [ "card", "account", "crypto", "unhostedWallet" ] }, "accountId": { "type": "string", "description": "Representation of the account ID: Account number, IBAN or DC hash for `card`, crypto wallet address for `crypto` type, and so on. Required for a counterparty in `travelRule` transactions, optional for applicants.\n\n⚠️ Mind that `accountId` is case-sensitive." }, "issuingCountry": { "type": "string", "description": "Alpha-3 code (e.g., `GBR`, `DEU`, `ARG`, etc.) of the country that issued the payment." }, "3dsUsed": { "type": "boolean", "description": "Indication of 3d secure auth being used." }, "2faUsed": { "type": "boolean", "description": "Indication of 2fa being used." }, "memo": { "type": "string", "description": "Optional field used for blockchain transactions where the receiving address is shared among multiple users (e.g., exchanges, custodians). It helps identify the specific end-user by carrying metadata such as a memo, tag, or payment ID (depending on the blockchain). This field is required for certain blockchains like XRP (destination tag), Stellar (memo), and EOS (memo)." } } }, "institutionInfo": { "type": "object", "description": "Applicant institution information.", "properties": { "code": { "type": "string", "description": "Institution code (e.g. BIC)." }, "name": { "type": "string", "description": "Institution name (e.g., Wells Fargo)." }, "address": { "type": "object", "description": "Institution address.", "properties": { "country": { "type": "string", "description": "Alpha-3 country code (for example, `DEU`, `GBR`, `ARG`, and so on)." }, "postCode": { "type": "string", "description": "Address postal code." }, "town": { "type": "string", "description": "The city, town, or another settlement." }, "street": { "type": "string", "description": "Street name." }, "subStreet": { "type": "string", "description": "Additional information related to the street. This could be a house number or any other details." }, "state": { "type": "string", "description": "The state, region, district, county or another territorial entity inside a country (if applicable)." }, "buildingName": { "type": "string", "description": "Building name (if applicable)." }, "flatNumber": { "type": "string", "description": "Flat or apartment number." }, "buildingNumber": { "type": "string", "description": "Building number." }, "formattedAddress": { "type": "string", "description": "Address in a human readable format. For example, `Design Offices, Philipsbornstraße 2, 30165 Hannover, Germany`." } } } } }, "email": { "type": "string", "description": "Email address" }, "phone": { "type": "string", "description": "Phone number." }, "idDoc": { "type": "object", "description": "Information from the applicant documents.", "properties": { "number": { "type": "string", "description": "Registration number of the document." }, "country": { "type": "string", "description": "Alpha-3 code (for example, `DEU`, `GBR`, `ARG`, and so on) of the country where the document was issued." }, "idDocType": { "type": "string", "description": "

Type of document that is specified in the level to be provided for verification. For example, `PASSPORT`, `UTILITY_BILL`, `VEHICLE_REGISTRATION_CERTIFICATE`, and so on.

See the lists of supported document types and supported company document types for details.

" }, "registrationAuthority": { "type": "string", "description": "Official name of the authority that registered the document." } } }, "residenceCountry": { "type": "string", "description": "Country of residence. Presented as an alpha-3 code (for example, `DEU`, `GBR`, `ARG`, and so on)." }, "leiCode": { "type": "string", "description": "Refers to a Legal Entity Identifier (LEI) code—public identifier from the financial entities registry." }, "licenseNumber": { "type": "string", "description": "Number of a license assigned for a time-bound term for a specific activity type, like banking or gambling. Applicable to the `company` type." }, "registrationNumber": { "type": "string", "description": "Primary identification number assigned to a legal entity during the registration process. Applicable to the `company` type." }, "companyType": { "type": "string", "description": "Type of legal entity. For example, private company limited by shares, public limited company, state-owned enterprise, and so on." }, "ceo": { "type": "object", "description": "Data related to the company's Chief Executive Officer.", "properties": { "firstName": { "type": "string", "description": "First name." }, "lastName": { "type": "string", "description": "Last name." }, "nameType": { "type": "string", "description": "Name type.", "enum": [ "aliasName", "birthName", "maidenName", "legalName", "shortName", "tradingName", "other" ] } } } } }, "counterparty": { "type": "object", "description": "Transaction participant data (sender or remitter depending on `info.direction`).", "properties": { "type": { "type": "string", "description": "Participant entity type.

ⓘ Required for Travel Rule transactions only.", "enum": [ "individual", "company" ] }, "externalUserId": { "type": "string", "description": "Unique identifier of the transaction participant (applicant or counterparty) on your side. 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.

⚠️ While this field is optional, it becomes required if you plan to use aggregation-based rules (for example, rules that evaluate a counterparty’s past transaction history). In such cases, you must provide a consistent `externalUserId` for that counterparty across all transactions." }, "fullName": { "type": "string", "description": "Full name of the participant. Required for the `company` type of applicant." }, "fullNameEn": { "type": "string", "description": "Participant’s full name transliterated in English. Use this field to provide an English version alongside the local-language name." }, "firstName": { "type": "string", "description": "First name." }, "firstNameEn": { "type": "string", "description": "Transliterated first name." }, "lastName": { "type": "string", "description": "Last name." }, "lastNameEn": { "type": "string", "description": "Transliterated last name." }, "nameType": { "type": "string", "description": "Name type.", "enum": [ "aliasName", "birthName", "maidenName", "legalName", "shortName", "tradingName", "other" ] }, "dob": { "type": "string", "description": "Date of birth.

⚠️ `dob` must fall within the supported date range `1900-01-01` to `2299-12-31` (inclusive). A value outside this range is rejected with a `400` error. This field remains optional — omitting it (or sending `null`) is accepted.", "format": "date" }, "placeOfBirth": { "type": "string", "description": "Place of birth. This can be a city, a town or another settlement type." }, "address": { "type": "object", "description": "Participant address.", "properties": { "country": { "type": "string", "description": "Alpha-3 country code (for example, `DEU`, `GBR`, `ARG`, and so on)." }, "postCode": { "type": "string", "description": "Address postal code." }, "town": { "type": "string", "description": "The city, town, or another settlement." }, "street": { "type": "string", "description": "Street name." }, "subStreet": { "type": "string", "description": "Additional information related to the street. This could be a house number or any other details." }, "state": { "type": "string", "description": "The state, region, district, county or another territorial entity inside a country (if applicable)." }, "buildingName": { "type": "string", "description": "Building name (if applicable)." }, "flatNumber": { "type": "string", "description": "Flat or apartment number." }, "buildingNumber": { "type": "string", "description": "Building number." }, "formattedAddress": { "type": "string", "description": "Address in a human readable format. For example, `Design Offices, Philipsbornstraße 2, 30165 Hannover, Germany`." } } }, "device": { "type": "object", "description": "Device information.", "properties": { "userAgent": { "type": "string", "description": "String with the HTTP header that your web browser sends to each requested page. E.g. `Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_2) AppleWebKit/601.3.9 (KHTML, like Gecko) Version/9.0.2 Safari/601.3.9`." }, "sessionId": { "type": "string", "description": "Transaction session identifier (e.g. `r-v3-812412m9e12d42`)." }, "sessionAgeMs": { "type": "integer", "description": "Session lifetime in milliseconds.", "format": "int64" }, "acceptLang": { "type": "string", "description": "From browser, e.g. `en`." }, "fingerprint": { "type": "string", "description": "Device fingerprint." }, "address": { "type": "object", "description": "Device address.", "properties": { "country": { "type": "string", "description": "Alpha-3 country code (for example, `DEU`, `GBR`, `ARG`, and so on)." }, "postCode": { "type": "string", "description": "Address postal code." }, "town": { "type": "string", "description": "The city, town, or another settlement." }, "street": { "type": "string", "description": "Street name." }, "subStreet": { "type": "string", "description": "Additional information related to the street. This could be a house number or any other details." }, "state": { "type": "string", "description": "The state, region, district, county or another territorial entity inside a country (if applicable)." }, "buildingName": { "type": "string", "description": "Building name (if applicable)." }, "flatNumber": { "type": "string", "description": "Flat or apartment number." }, "buildingNumber": { "type": "string", "description": "Building number." }, "formattedAddress": { "type": "string", "description": "Address in a human readable format. For example, `Design Offices, Philipsbornstraße 2, 30165 Hannover, Germany`." } } }, "coords": { "type": "object", "description": "Coordinates.", "properties": { "lat": { "type": "number", "description": "Position latitude in decimal degrees.", "format": "double" }, "lon": { "type": "number", "description": "Position longitude in decimal degrees.", "format": "double" }, "accuracy": { "type": "string", "description": "Accuracy of the latitude and longitude properties, expressed in meters." } } }, "ipInfo": { "type": "object", "description": "Data about used IP address.", "properties": { "lat": { "type": "number", "description": "Position latitude in decimal degrees.", "format": "double" }, "lon": { "type": "number", "description": "Position longitude in decimal degrees.", "format": "double" }, "ip": { "type": "string", "description": "IP address." }, "countryCode3": { "type": "string", "description": "Country code (ISO 3166-1 alpha-3)." }, "asn": { "type": "integer", "description": "Autonomous System Number.", "format": "int32" }, "asnOrg": { "type": "string", "description": "ASN organisation." }, "riskyAsn": { "type": "boolean", "description": "Determines if the ASN is risky (`true`) or not (`false`)." } } } } }, "paymentMethod": { "type": "object", "description": "Information about the payment method.", "properties": { "type": { "type": "string", "description": "Payment method type.", "enum": [ "card", "account", "crypto", "unhostedWallet" ] }, "accountId": { "type": "string", "description": "Representation of the account ID: Account number, IBAN or DC hash for `card`, crypto wallet address for `crypto` type, and so on. Required for a counterparty in `travelRule` transactions, optional for applicants.\n\n⚠️ Mind that `accountId` is case-sensitive." }, "issuingCountry": { "type": "string", "description": "Alpha-3 code (e.g., `GBR`, `DEU`, `ARG`, etc.) of the country that issued the payment." }, "3dsUsed": { "type": "boolean", "description": "Indication of 3d secure auth being used." }, "2faUsed": { "type": "boolean", "description": "Indication of 2fa being used." }, "memo": { "type": "string", "description": "Optional field used for blockchain transactions where the receiving address is shared among multiple users (e.g., exchanges, custodians). It helps identify the specific end-user by carrying metadata such as a memo, tag, or payment ID (depending on the blockchain). This field is required for certain blockchains like XRP (destination tag), Stellar (memo), and EOS (memo)." } } }, "institutionInfo": { "type": "object", "description": "Counterparty institution information.", "properties": { "code": { "type": "string", "description": "Institution code (e.g. BIC)." }, "name": { "type": "string", "description": "Institution name (e.g. Wells Fargo)." }, "address": { "type": "object", "description": "Institution address.", "properties": { "country": { "type": "string", "description": "Alpha-3 country code (for example, `DEU`, `GBR`, `ARG`, and so on)." }, "postCode": { "type": "string", "description": "Address postal code." }, "town": { "type": "string", "description": "The city, town, or another settlement." }, "street": { "type": "string", "description": "Street name." }, "subStreet": { "type": "string", "description": "Additional information related to the street. This could be a house number or any other details." }, "state": { "type": "string", "description": "The state, region, district, county or another territorial entity inside a country (if applicable)." }, "buildingName": { "type": "string", "description": "Building name (if applicable)." }, "flatNumber": { "type": "string", "description": "Flat or apartment number." }, "buildingNumber": { "type": "string", "description": "Building number." }, "formattedAddress": { "type": "string", "description": "Address in a human readable format. For example, `Design Offices, Philipsbornstraße 2, 30165 Hannover, Germany`." } } }, "internalId": { "type": "string", "description": "VASP ID for counterparty transactions. If provided, we trust the exchange and use the expected VASP for transaction approval. If not provided, we will attempt to find the VASP by the wallet address.

ⓘ Applicable to Travel Rule transactions only." } } }, "email": { "type": "string", "description": "Email address." }, "phone": { "type": "string", "description": "Phone number." }, "idDoc": { "type": "object", "description": "Information from the counterparty documents.", "properties": { "number": { "type": "string", "description": "Registration number of the document." }, "country": { "type": "string", "description": "Alpha-3 code (for example, `DEU`, `GBR`, `ARG`, and so on) of the country where the document was issued." }, "idDocType": { "type": "string", "description": "

Type of document that is specified in the level to be provided for verification. For example, `PASSPORT`, `UTILITY_BILL`, `VEHICLE_REGISTRATION_CERTIFICATE`, and so on.

See the lists of supported document types and supported company document types for details.

" }, "registrationAuthority": { "type": "string", "description": "Official name of the authority that registered the document." } } }, "residenceCountry": { "type": "string", "description": "Country of residence. Presented as an alpha-3 code (for example, `DEU`, `GBR`, `ARG`, and so on)." }, "leiCode": { "type": "string", "description": "Refers to a Legal Entity Identifier (LEI) code—public identifier from the financial entities registry." }, "licenseNumber": { "type": "string", "description": "Number of a license assigned for a time-bound term for a specific activity type, like banking or gambling. Applicable to the `company` type." }, "registrationNumber": { "type": "string", "description": "Primary identification number assigned to a legal entity during the registration process. Applicable to the `company` type." }, "companyType": { "type": "string", "description": "Type of legal entity. For example, private company limited by shares, public limited company, state-owned enterprise, and so on." }, "ceo": { "type": "object", "properties": { "firstName": { "type": "string", "description": "First name." }, "lastName": { "type": "string", "description": "Last name." }, "nameType": { "type": "string", "description": "Name type.", "enum": [ "aliasName", "birthName", "maidenName", "legalName", "shortName", "tradingName", "other" ] } } } } }, "type": { "type": "string", "description": "Transaction type.", "default": "finance", "enum": [ "finance", "kyc", "login", "signup", "passwordChange", "twoFaReset", "travelRule" ] }, "sourceKey": { "type": "string", "description": "[Source key](https://docs.sumsub.com/sumsub/docs/source-keys) indication to separate accesses to transactions." } } }, "tags": { "type": "array", "description": "Tags to add (one tag per string).

Mind the following:
  • You can only add tags that are created and stored in the Dashboard settings.
  • Tag names are case sensitive. For example, Suspicious and suspicious are considered different.
", "items": { "type": "string" } }, "review": { "type": "object", "description": "Includes the details of the transaction status and check result.

⚠️ To pass the `review` object, set the `scoreSavedTxns` parameter to `false`.", "required": [ "reviewStatus" ], "properties": { "reviewResult": { "type": "object", "required": [ "reviewAnswer" ], "properties": { "reviewAnswer": { "type": "string", "description": "
  • GREEN — transaction is approved.
  • RED — transaction is rejected.
" } } }, "reviewStatus": { "type": "string", "description": "

Indicates the transaction status. Allowed values:

  • completed — transaction review is complete and final.
  • onHold — requires manual verification.
" } } } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```