--- updatedAt: 2026-09-29T10:35:54.000Z agentTools: projectIndex: https://docs.sumsub.com/llms.txt --- # Get transaction information by `txnId` # Overview Use this method to retrieve the transaction information using the `txnId` (unique transaction identifier in your system). ## Required permissions To use this method, your [app token](https://docs.sumsub.com/sumsub/docs/app-tokens) must have the **View TM transactions** [permission](https://docs.sumsub.com/sumsub/docs/user-roles#permissions). # Request example ```curl curl -X GET \ 'https://api.sumsub.com/resources/kyt/txns/-;data.txnId=03e47b09-f77e-4da8-9b58-4925e5derrff/one' \ -H 'X-App-Token: ' \ -H 'X-App-Access-Sig: ' \ -H 'X-App-Access-Ts: ' ``` # Response explained The response is a JSON file that represents the structured transaction information available in the Sumsub system. The existence of some fields depends on the transaction type and matched [rules](/docs/tm-rules). Below, you can see the response structure and possible content with descriptions: * [Root variables](#root-variables) * [data](#data-attributes) * [data.applicant](#dataapplicant-attributes) * [data.counterparty](#datacounterparty-attributes) * [address](#address-attributes) * [paymentMethod](#paymentmethod-attributes) * [device](#device-attributes) * [ipInfo](#ipinfo-attributes) * [coords](#coords-attributes) * [institutionInfo](#institutioninfo-and-institutionextractedinfo-attributes), [institutionExtractedInfo](#institutioninfo-and-institutionextractedinfo-attributes) * [vasp](#vasp-attributes) * [data.info](#datainfo-attributes) * [data.info.cryptoParams](#datainfocryptoparams-attributes) * [review](#review-attributes) * [scoringResult](#scoringresult-attributes) * [matchedRules](#matchedrules-element-fields) * [travelRuleInfo](#travelruleinfo-attributes) * [cryptoTxnInfo](#cryptotxninfo-attributes) ## Root variables The following table explains the root variables that represent the core transaction data items. Some of them may include nested attributes and element fields.
Field Type Description
`id` String Unique transaction identifier in the Sumsub system. Save it in order to filter and/or search transactions.
`applicantId` String Unique applicant identifier in the Sumsub system (`applicantId`). This identifier is a random combination of 24 digits and lowercase Latin characters. It is automatically generated when the applicant profile is created on the Sumsub side.
`externalUserId` String Unique transaction participant identifier as it is registered on your side.
`clientId` String Unique identifier of you as our client in the Sumsub system. This identifier is assigned to you when you are registered in and get access to the Sumsub system. It usually resembles your name or your company name. `clientId` is automatically added to the applicant profile when it is created.
`data` [Object](#data-attributes) Transaction-related data submitted to Sumsub by the user. This data includes such details as transaction identifier, date and time when the transaction was initiated on the user side, financial information, transaction participants, and so on.
`score` Integer Transaction score based on the triggered [rules](/docs/tm-rules).
`review` [Object](#review-attributes) Explains the details of transaction status and check result.
`createdAt` Date Date and time (UTC) when a transaction was created in the Sumsub system.
`scoringResult` [Object](#scoringresult-attributes) Includes an overall scoring result and its details.
`needMasking` Boolean Indicates whether personal data is masked. - `true` — personal data is masked, so `fullName` is not included in the `applicant` and `counterparty` objects. Personal data remains masked when you [reject the transaction ownership](https://docs.sumsub.com/sumsub/reference/confirm-or-reject-transaction-ownership). - `false` — transaction ownership is confirmed, and `fullName` is included in the `applicant` and `counterparty` objects.
`txnInactive` Boolean If this field returns `true`, the applicant profile associated with the transaction is deleted.
`cryptoTxnInfo` [Object](#cryptotxninfo-attributes) Risk-score data collected by external providers configured for the transaction. Each provider's data is contained in its own object and is populated only when that provider is enabled.
`kytCaseIds` [Array of objects](#kytcaseids-element-fields) IDs of the KYT cases linked to this transaction. Populated only when one or more cases reference it.
## `kytCaseIds[]` element fields | Field | Type | Description | | ----------- | ------ | ------------------------------------------------------------- | | `kytCaseId` | String | Unique identifier of the KYT case linked to this transaction. | ## `data` attributes The following table explains the `data` object fields which represent the transaction-related data submitted to Sumsub by the user. This data includes such details as transaction identifier, date and time when the transaction was initiated on the user side, financial information, transaction participants, and so on. | Field | Type | Description | | :------------- | :------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `txnId` | String | Unique transaction identifier in your system (alphanum). | | `txnDate` | Date | The date and time (UTC) when a transaction was initiated on your side (format `yyyy-MM-dd HH:mm:ss+XXXX` , for example, `2022-10-25 22:30:02+0000`). | | `applicant` | [Object](#dataapplicant-attributes) | Includes the data of the financial transaction participant registered in the Sumsub system as an applicant. This data is submitted to Sumsub within the transaction and may differ from the relevant applicant profile.
The applicant can be a sender or remitter depending on the `info.direction` parameter. | | `counterparty` | [Object](#datacounterparty-attributes) | Includes the data related to the other party that participates in the financial transaction. This data is submitted to Sumsub within the transaction.
The counterparty can be a sender or remitter depending on the `info.direction` parameter. | | `type` | String | Transaction type. Expects values:
  • finance(default)
  • kyc
  • travelRule
  • userPlatformEvent
    • login
    • signup
    • passwordChange
    • twoFaReset
| | `info` | [Object](#datainfo-attributes) | Transaction-related financial information. | | `props` | Map of strings | Map of strings in JSON format with custom keys and string values. Represents transaction properties. | ## `data.applicant` attributes The following table explains the `data.applicant` object fields which contain the data of the financial transaction participant registered in the Sumsub system as an applicant. This data is submitted to Sumsub within a transaction and may differ from the relevant applicant profile. An applicant can be a sender or remitter depending on the `info.direction` parameter. | Field | Type | Description | | :--------------------------- | :----------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `externalUserId` | String | Unique applicant identifier as it is on your side.
You can generate and add it manually when [creating an applicant](/reference/create-applicants). If not, the external user ID is added automatically. | | `fullName` | String | Applicant full name. | | `firstName` | String | First name. | | `firstNameEn` | String | Transliterated first name. | | `lastName` | String | Last name | | `lastNameEn` | String | Transliterated last name. | | `nameType` | String | Name type. `aliasName`, `birthName`, `maidenName`, `legalName`, `shortName`, `tradingName`, `other`. | | `dob` | Date | Date of birth (format `yyyy-mm-dd`). | | `placeOfBirth` | String | Place of birth. This can be a city, a town or another settlement type. | | `address` | [Object](#address-attributes) | Applicant actual address details (if provided). | | `type` | Enum | Applicant [entity type](/docs/applicants): `individual` or `company`. | | `email` | String | Email address. | | `phone` | String | Phone number. | | `idDoc` | [Object](#iddoc-attributes) | Information from the documents. | | `paymentMethod` | [Object](#paymentmethod-attributes) | Payment method used by the applicant. | | `paymentMethodExtractedInfo` | Object | Payment method information extracted from available data (represents the type that could be `smartContract`, `bankCard`, or `bankAccount`). | | `device` | [Object](#device-attributes) | Technical data of the device used by the applicant to complete a transaction. | | `institutionInfo` | [Object](#institutioninfo-and-institutionextractedinfo-attributes) | Information regarding the financial institution through which the applicant made a transaction. | | `institutionExtractedInfo` | [Object](#institutioninfo-and-institutionextractedinfo-attributes) | Financial institution information extracted from available data. Stands for BIC country. | | `residenceCountry` | String | Country of residence. Presented as an alpha-3 code (for example, `DEU`, `GBR`, `ARG`). | | `leiCode` | String | LEI number (Legal Entity Identifier) is a unique 20-character alphanumeric code used to identify legal entities engaging in financial transactions. | | `licenseNumber` | String | 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` | String | Primary identification number assigned to a legal entity during the registration process. Applicable to the `company` type. | | `companyType` | String | Type of legal entity. For example, private company limited by shares, public limited company, state-owned enterprise, and so on. Applicable to the `company` type. | | `ceo` | [Object](#ceo-attributes) | Data related to the company's Chief Executive Officer. Applicable to the `company` type. | ## `data.counterparty` attributes The following table explains the `data.counterparty` object fields which contain the data related to the other party that participates in the financial transaction. This data is submitted to Sumsub within a transaction. A counterparty can be a sender or remitter depending on the `info.direction` parameter. | Field | Type | Description | | :--------------------------- | :----------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `externalUserId` | String | Unique user identifier as it is on your side. | | `fullName` | String | Counterparty full name. | | `firstName` | String | First name. | | `firstNameEn` | String | Transliterated first name. | | `lastName` | String | Last name | | `lastNameEn` | String | Transliterated last name. | | `nameType` | String | Name type. `aliasName`, `birthName`, `maidenName`, `legalName`, `shortName`, `tradingName`, `other`. | | `dob` | Date | Date of birth (format `yyyy-mm-dd`). | | `placeOfBirth` | String | Place of birth. This can be a city, a town or another settlement type. | | `address` | [Object](#address-attributes) | Counterparty actual address details (if provided). | | `type` | Enum | Counterparty [entity type](https://docs.sumsub.com/sumsub/docs/applicants): `individual` or `company`. | | `email` | String | Email address. | | `phone` | String | Phone number. | | `idDoc` | [Object](#iddoc-attributes) | Information from the documents. | | `paymentMethod` | [Object](#paymentmethod-attributes) | Payment method used by a counterparty. | | `paymentMethodExtractedInfo` | Object | Payment method information extracted from available data (represents the type that could be `smartContract`, `bankCard`, or `bankAccount`). | | `device` | [Object](#device-attributes) | Technical data of the device used by a counterparty to complete a transaction. | | `institutionInfo` | [Object](#institutioninfo-and-institutionextractedinfo-attributes) | Information regarding the financial institution through which a counterparty made a transaction. | | `institutionExtractedInfo` | [Object](#institutioninfo-and-institutionextractedinfo-attributes) | Financial institution information extracted from available data. Stands for BIC country. | | `residenceCountry` | String | Country of residence. Presented as an alpha-3 code (for example, `DEU`, `GBR`, `ARG`). | | `leiCode` | String | LEI number (Legal Entity Identifier) is a unique 20-character alphanumeric code used to identify legal entities engaging in financial transactions. | | `licenseNumber` | String | 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` | String | Primary identification number assigned to a legal entity during the registration process. Applicable to the `company` type. | | `companyType` | String | Type of legal entity. For example, private company limited by shares, public limited company, state-owned enterprise, and so on. Applicable to the `company` type. | | `ceo` | [Object](#ceo-attributes) | Data related to the company's Chief Executive Officer. Applicable to the `company` type. | ## `address` attributes The following table includes the details of the actual address (if provided). The address may be associated with a user, a device in use, a financial institution, and so on, depending on the object to which the `address` parameter refers. | Field | Type | Description | | :----------------- | :----- | :--------------------------------------------------------------------------------------------------------------- | | `buildingName` | String | Building name. | | `flatNumber` | String | Flat or apartment number. | | `subStreet` | String | Additional information related to the street. This could be a house number or any other details. | | `subStreetEn` | String | Automatic transliteration of the additional information related to the street into Latin characters. | | `street` | String | Street name. | | `streetEn` | String | Automatic transliteration of the street name into Latin characters. | | `state` | String | State, region, district, county or another territorial entity inside a country. | | `stateEn` | String | Automatic transliteration of the territorial entity into Latin characters. | | `buildingNumber` | String | Building number. | | `town` | String | City, town, or another settlement. | | `townEn` | String | Automatic transliteration of the settlement into Latin characters. | | `postCode` | String | Address postal code. | | `country` | String | Alpha-3 country code (for example, `DEU`, `GBR`, `ARG`, and so on). | | `formattedAddress` | String | Address in a human readable format. For example, `Design Offices, Philipsbornstraße 2, 30165 Hannover, Germany`. | ## `idDoc` attributes | Field | Type | Description | | :---------------------- | :----- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `number` | String | Registration number of the document. | | `country` | String | Alpha-3 code (for example, `DEU`, `GBR`, `ARG`) of the country where the document was issued. | | `idDocType` | String | Type of document that is specified in the level to be provided for verification. For example, `PASSPORT`, `UTILITY_BILL`, `VEHICLE_REGISTRATION_CERTIFICATE`.

See the lists of [supported document types](https://docs.sumsub.com/sumsub/reference/add-verification-documents#supported-document-types) and [supported company document types](https://docs.sumsub.com/sumsub/reference/add-verification-documents#supported-company-document-types) for details. | | `registrationAuthority` | String | Official name of the authority that registered the document. | ## `paymentMethod` attributes The following table explains the details of the payment method used by the transaction participant. | Field | Type | Description | | :--------------- | :------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `type` | String | Payment method type that was specified when [submitting a transaction](https://docs.sumsub.com/sumsub/reference/submit-transaction-for-existing-applicant).
Possible values include `bankCard`, `bankAccount`, `eWallet`, `cryptoWallet`, `unhostedWallet`, `other`, and so on. | | `accountId` | String | Representation of the account ID: account number, IBAN/BIC or DC hash for `card`, crypto wallet address for `crypto` type, smart contract or not, and so on. | | `issuingCountry` | String | Payment issuing country code in Alpha-3 format (ISO 3166-1). For example, `DEU`, `GBR`, `ARG`, and so on. | | `3dsUsed` | Boolean | Indicates if 3d secure authentication was used. | | `2faUsed` | Boolean | Indicates if 2FA (two-factor authentication) was used. | | `memo` | String | 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). | ## `device` attributes The following table explains the specifications associated with the device used by the transaction participant to complete a transaction. | Field | Type | Description | | :-------------- | :---------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ipInfo` | [Object](#ipinfo-attributes) | Includes the data related to the used IP address. | | `userAgent` | String | Device user-agent. | | `sessionId` | String | Identifier of the transaction session. | | `sessionAgeMs` | Long | The session lifetime in milliseconds. | | `acceptLang` | String | Language of the browser used by a transaction participant, e.g. `en`. | | `platform` | String | Device platform, e.g. `Mobile Android`. | | `coords` | [Object](#coords-attributes) | Geographical coordinates. | | `address` | [Object](#address-attributes) | The address related to a device. | | `fingerprint` | String | Device fingerprint. | | `byokRequestId` | String | The `requestId` of a device fingerprint event collected through your own Fingerprint Pro integration for this specific transaction or event, independent of any Sumsub SDK session. Sumsub uses this ID to fetch the corresponding device data from your Fingerprint Pro account and attach it to the transaction for risk scoring. Nullable. | ## `ipInfo` attributes This table explains the data elements associated with the IP address. | Field | Type | Description | | :------------- | :------ | :------------------------------------------------------------------ | | `ip` | String | IP address. | | `countryCode2` | String | Country code (ISO 3166-1 alpha-2). | | `countryCode3` | String | Country code (ISO 3166-1 alpha-3). | | `city` | String | City the IP address belongs to. | | `zipCode` | String | ZIP code. | | `lat` | Double | Represents the position latitude in decimal degrees. | | `lon` | Double | Represents the position longitude in decimal degrees. | | `asn` | Integer | Autonomous System Number. | | `asnOrg` | String | ASN organization. | | `riskyAsn` | Boolean | A value determining whether ASN is risky (`true`) or not (`false`). | ## `coords` attributes This table describes the data elements representing geographical coordinates. | Field | Type | Description | | :--------- | :----- | :------------------------------------------------------------------------------------- | | `lat` | Double | Represents the position's latitude in decimal degrees. | | `lon` | Double | Represents the position's longitude in decimal degrees. | | `accuracy` | Double | Represents the accuracy of the latitude and longitude properties, expressed in meters. | ## `institutionInfo` and `institutionExtractedInfo` attributes The following table explains the attributes of the `institutionInfo` and `institutionExtractedInfo` objects: * `institutionInfo` — Information regarding the financial institution through which a participant made a transaction. * `institutionExtractedInfo` — Financial institution information extracted from available data. | Field | Type | Description | | :----------- | :---------------------------- | :----------------------------------------------------------------------------------------------------------------------------------- | | `code` | String | Transaction institution code, e.g. BIC. | | `name` | String | Transaction institution name. | | `address` | [Object](#address-attributes) | Transaction institution address. | | `internalId` | String | VASP identifier for counterparty transaction. If provided, we trust the exchange and use the expected VASP for transaction approval. | ## `ceo` attributes | Field | Type | Description | | :---------- | :----- | :------------------------------------------------------------------------------------------------------------ | | `firstName` | String | First name. | | `lastName` | String | Last name. | | `nameType` | String | Name type. Allowed: `aliasName`, `birthName`, `maidenName`, `legalName`, `shortName`, `tradingName`, `other`. | ## `data.info` attributes The following table explains the transaction-related financial information. | Field | Type | Description | | :------------------------ | :----------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------- | | `direction` | String |
  • out — the applicant sends to the counterparty.
  • in — the counterparty sends to the applicant.
| | `amount` | Double | The amount of funds sent within a transaction (in a currency used by an applicant). The round transaction amounts are detected: 10, 5000, 100000, and so on. | | `currencyCode` | String | Code of the currency in which the transaction was made. | | `currencyType` | String | Indicates whether the transaction is `crypto` or `fiat`. | | `amountInDefaultCurrency` | Double | Transaction amount in the default currency. | | `defaultCurrencyCode` | String | Code of the default currency. | | `paymentTxnId` | String | Crypto transaction identifier from the blockchain. | | `paymentDetails` | String | Remittance or payment reference information. | | `paymentTxnId` | String | Crypto transaction identifier from the blockchain. | | `cryptoParams` | [Object](#datainfocryptoparams-attributes) | Crypto transaction parameters. | ## `data.info.cryptoParams` attributes The following table describes the crypto transaction parameters. | Field | Type | Description | | :---------------- | :------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `attemptId` | String | Unique identifier of the transaction attempt. | | `outputIndex` | Integer | Index number for a transaction output. | | `cryptoChain` | String | 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/working-with-crypto-assets). | | `contractAddress` | String | Smart-contract address of the token. This field is used to distinguish assets that share the same currencyCode and cryptoChain but represent different tokens. | ## `review` attributes The following table explains the details of the transaction status and check result. | Field | Type | Description | | :---------------------- | :--------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `reviewId` | String | Unique identifier of the transaction check in the Sumsub system. | | `attemptId` | String | Unique identifier of the check attempt.
Transaction checks can be initiated more than once if, for example, they failed and the information was added/changed. | | `attemptCnt` | Integer | The counting number of the check attempt. | | `elapsedSincePendingMs` | Long | Elapsed time since the transaction check passed to the `pending` status. | | `createDate` | Date | Date and time (UTC) when the transaction review was created. | | `reviewDate` | Date | Date and time (UTC) when the transaction review was completed. | | `reviewResult` | [Object](#reviewresult-attributes) | Explains the transaction review result. | | `reviewStatus` | String | Indicates the transaction status ( `onHold`, `completed`, `init`, `awaitingUser`). | | `confirmed` | Boolean | Indicates whether the officer has confirmed the verdict on the transaction as defined by the [rules](/docs/tm-rules). | ## `reviewResult` attributes Contains the `reviewAnswer` parameter that explains the transaction review result. | Field | Type | Description | | :----------------- | :----- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `reviewAnswer` | String | Explains the transaction review result.
  • GREEN — the transaction is approved.
  • RED — the transaction is declined.
| | `reviewRejectType` | String | Indicates the type of rejection.
  • FINAL — Rejected status in case of major violations. The transaction cannot be resubmitted for verification.
  • RETRY — Resubmission requested status in case of minor violations. The transaction can be resubmitted with new information provided.
| ## `scoringResult` attributes The following table explains the transaction overall scoring result and its details. | Field | Type | Description | | :----------------- | :--------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------- | | `score` | Integer | Calculated score of a transaction. | | `dryScore` | Integer | Calculated dry score of the transaction which would be assigned by the rules applied in the [dry run](/docs/tm-testing) mode. | | `applicantActions` | [Array of objects](#applicantactions-element-fields) | Each object includes applicant action data. | | `matchedRules` | [Array of objects](#matchedrules-element-fields) | All [rules](/docs/tm-rules) that matched during the scoring session. | | `failedRules` | Array of objects | All rules that failed during the scoring session. | | `action` | String | Result of all matched rules combined (`score` / `onHold` / `reject` / `approved`, and so on). | | `ruleCnt` | Integer | Total number of the rules counted for a transaction. | | `dryRunRuleCnt` | Integer | Total number of the dry run rules counted for a transaction. | ## `applicantActions` element fields The following table describes the object fields of the `applicantActions` array. | Field | Type | Description | | :------------------ | :----- | :----------------------------------------------------- | | `applicantActionId` | String | Unique applicant action identifier on the Sumsub side. | | `externalActionId` | String | Unique applicant action identifier on your side. | ## `matchedRules` element fields The following table explains the details of the rule that matched during the scoring session. Each rule is represented by an individual object inside the `matchedRules` array. | Field | Type | Description | | :--------- | :------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | String | Rule identifier. | | `name` | String | Rule name. | | `revision` | Integer | Rule revision. Incremented after the rule has been edited. | | `title` | String | Rule title. | | `score` | Integer | Amount that will be added to the overall score if the rule is matched. | | `dryRun` | Boolean | Indicates whether the rule is applied in a dry run mode (no affection on the transaction, no side effects).
  • true — the rule in the dry run mode.
  • false — the rule in the regular mode.
| | `action` | String | Result action of the matched rule (`score` / `onHold` / `reject`). | ## `travelRuleInfo` attributes | Field | Type | Description | | :----------------------------------- | :---------------------------- | :------------------------------------------------------------------------------------- | | `protocolName` | [Enum](#protocolname-types) | The name of the protocol used during the information exchange. | | `applicant` | Object | Applicant information used during the information exchange. | | `counterparty` | Object | Counterparty information used during the information exchange. | | `status` | [Enum](#travelruleinfostatus) | The current information exchange state. | | `expiredAt` | Date | If the timer is set, the transaction will be re-scored after a certain period of time. | | `applicantVaspId` | ObjectId | Stores information about the applicant VASP institution. | | `counterpartyVaspId` | ObjectId | Stores information about the counterparty VASP institution. | | `needApplicantOwnershipConfirmation` | Boolean | True if applicant data confirmation is required. | ## `protocolName` types | Value | Description | | :--------- | :-------------------------------------------------- | | `sns` | [Sumsub protocol](https://docs.sumsub.com/sumsub/docs/sumsub-protocol). | | `gtr` | [Global Travel Rule Protocol](https://docs.sumsub.com/sumsub/docs/gtr-protocol). | | `trp` | [Travel Rule Protocol](https://docs.sumsub.com/sumsub/docs/trp-protocol). | | `sygna` | [Sygna Bridge protocol](https://docs.sumsub.com/sumsub/docs/sygna-bridge-protocol). | | `vba` | VASP By Address. | | `fallback` | Fallback notification. | ## travelRuleInfo.status | Value | Description | | :------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `awaitingCounterparty` | The counterparty was successfully identified, and the data has been sent. Awaiting a response from the counterparty. | | `cancelled` | The counterparty was identified, and the data was sent. However, the sender decided to cancel the transaction, either in accordance with the rules or manually, and not to proceed with it.
The counterparty was identified, and the data was not sent. Because some the rule rejected the transaction. | | `completed` | Data exchange completed. | | `counterpartyMismatchedData` | The counterparty cross-checked the data we provided against their records and reported a mismatch. | | `counterpartyVaspNotFound` | The transaction targets an unhosted wallet, or the counterparty VASP could not be identified. | | `counterpartyVaspNotReachable` | The counterparty is not reachable due to missing protocol support.
To simulate this scenario, use the "Sumsub test not reachable VASP" (ID: 683584cd36898664230ee173) in your transaction. | | `expired` | The counterparty was identified, and the data was sent. However, no response was received from the counterparty within the expected timeframe. The confirmation timeout settings can be adjusted in the **Transactions** and **Travel Rule** -> **Settings** -> **General** tab. | | `finished` | The blockchain transaction ID has been updated in the **Completed** transaction record. This status always follows the **Completed** status. | | `onHold` | For inbound messages, wallet ownership has been confirmed. Review the customer details and confirm or decline the data match. | | `unconfirmedOwnership` | The counterparty VASP has specified that the wallet address is not controlled by their organisation. | | `counterpartyVaspGeneralDecline` | For inbound and outbound messages, the counterparty declines the transaction. Mostly applicable when dealing with counterparties on connected protocols. | | `notEnoughCounterpartyData` | Not enough information was found about the second side of the transaction. | # `cryptoTxnInfo` attributes Risk-score data collected by external providers configured for the transaction. Each provider's data is contained in its own object and is populated only when that provider is enabled. | Field | Type | Description | | ------------------------ | -------------------------------------------- | --------------------------------------------------------------------------------------------- | | `crystalMonitorData` | [Object](#crystalmonitordata-attributes) | Risk data from **Crystal**, including the counterparty entity, signals, and a roll-up answer. | | `chainalysisMonitorData` | [Object](#chainalysismonitordata-attributes) | Risk data from **Chainalysis** (entity/address alert and exposures). | | `ellipticMonitorData` | [Object](#ellipticmonitordata-attributes) | Risk data from **Elliptic**: wallet-exposure analysis and transfer screening. | | `trmLabsMonitorData` | [Object](#trmlabsmonitordata-attributes) | Risk data from **TRM Labs**: wallet screening and transfer screening. | | `merkleMonitorData` | [Object](#merklemonitordata-attributes) | Risk data from **Merkle Science**: wallet screening and transfer screening. | *** ## `crystalMonitorData` attributes Result of the Crystal screening. | Field | Type | Description | | ---------------- | ----------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | | `answer` | String (Enum) | Sumsub-derived result: `GREEN`, `YELLOW`, `RED`, `ERROR`, or `IGNORED`. Computed from the counterparty's risk score and blocklist flag. | | `assetSupported` | Boolean | `true` if Crystal supports the requested currency/chain. | | `counterparty` | [Object](#crystalmonitordatacounterparty-attributes) | Crystal's view of the counterparty address being screened. | | `signals` | [Object](#crystalmonitordatasignals-and-counterpartysignalsreceivedsent-attributes) | Aggregated risk-category signal scores returned by Crystal at the top level of the response. | | `blockchains` | Array of strings | Blockchains reported by Crystal for the address. | | `amount` | Number | Transaction amount as parsed from the response (native units). | | `fiat` | Number | Transaction value in the configured fiat currency. | | `time` | Date | Crystal's timestamp for the transaction (format `yyyy-MM-dd HH:mm:ss`). | ## `crystalMonitorData.counterparty` attributes Information about the counterparty entity Crystal attributed the address to. | Field | Type | Description | | ----------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------ | | `address` | String | Counterparty wallet address (may be `null` if not returned by Crystal). | | `entity` | [Object](#crystalmonitordatacounterpartyentity-attributes) | Identified entity owning the address (e.g. exchange, mixer). | | `blocklist` | Boolean | `true` if the address is on Crystal's internal blocklist. | | `received` | Number | Total amount received by the counterparty (Crystal raw units). | | `sent` | Number | Total amount sent by the counterparty (Crystal raw units). | | `riskScore` | Number | Counterparty risk score in the range `0–1`. Higher means riskier. | | `signals` | [Object](#crystalmonitordatacounterpartysignals-attributes) | Per-direction breakdown of risk-category exposures (`received`/`sent`). | | `tags` | Array of strings | Crystal tags attached to the counterparty. | | `type` | String | Counterparty type as classified by Crystal (for example, `entity`, `address`). | ## `crystalMonitorData.counterparty.entity` attributes | Field | Type | Description | | --------------- | ---------------- | ------------------------------------------------------------------------------------------ | | `globalId` | Long | Crystal's unique identifier for the entity. | | `grade` | String | Crystal grade label (for example, `A`, `B`, …) when assigned. | | `nTx` | Long | Number of transactions Crystal has observed for this entity. | | `name` | String | Human-readable entity name (for example,`HTX (prev. Huobi)`). | | `slug` | String | URL-friendly slug identifying the entity. | | `subtype` | String | Entity subtype, where applicable. | | `type` | String | Entity type. For example, `exchange_licensed`, `exchange_unlicensed`, `mixer`, `gambling`. | | `country` | String | Country where the entity is registered (Alpha-3 code). | | `currencyBasic` | Array of strings | Basic-list currencies the entity supports. | | `currency` | Array of strings | Full list of currencies the entity supports. | ## `crystalMonitorData.counterparty.signals` attributes | Field | Type | Description | | ---------- | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------ | | `received` | [Object](#crystalmonitordatasignals-and-counterpartysignalsreceivedsent-attributes) | Risk-category exposures for incoming volume to the counterparty. | | `sent` | [Object](#crystalmonitordatasignals-and-counterpartysignalsreceivedsent-attributes) | Risk-category exposures for outgoing volume from the counterparty. | ## `crystalMonitorData.signals` and `counterparty.signals.{received,sent}` attributes Each signal is a value in `[0, 1]` representing the share of volume exposed to the named risk category (per Crystal's classification). | Field | Type | Description | | ------------------------- | ------ | ----------------------------------------------------------------------------- | | `atm` | Number | Crypto ATM operator. | | `dark_market` | Number | Online marketplace operating via darknets, used for trading illegal products. | | `child_exploitation` | Number | Suspected child abuse/exploitation. | | `dark_service` | Number | Darknet-based service offering illegal services. | | `exchange_licensed` | Number | Licensed exchange service. | | `exchange_unlicensed` | Number | Unlicensed exchange service. | | `p2p_exchange_licensed` | Number | Licensed P2P exchange. | | `p2p_exchange_unlicensed` | Number | Unlicensed P2P exchange. | | `enforcement_action` | Number | Subject to enforcement action by an authority. | | `exchange_fraudulent` | Number | Exchange linked to illegal activity. | | `gambling` | Number | Gambling service. | | `illegal_service` | Number | Resource offering illegal services or engaged in illegal activities. | | `marketplace` | Number | Legal marketplace trading goods/services for crypto. | | `miner` | Number | Crypto-mining organisation. | | `mixer` | Number | Mixing / tumbler service. | | `payment` | Number | Payment-processing intermediary. | | `ransom` | Number | Extortion / ransomware. | | `scam` | Number | Entity that has scammed customers. | | `stolen_coins` | Number | Coins obtained via hacking / theft. | | `wallet` | Number | Wallet provider. | | `terrorism_financing` | Number | Terrorism-financing exposure. | | `liquidity_pools` | Number | DeFi liquidity-pool exposure. | | `sanctions` | Number | Sanctioned entity. | | `seized_assets` | Number | Assets known to have been seized. | | `other` | Number | Other categories not covered above. | *** ## `chainalysisMonitorData` attributes Result of the Chainalysis screening. | Field | Type | Description | | -------------------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | | `addressAlert` | [Object](#chainalysismonitordataaddressalert-attributes) | Address-level alert returned by Chainalysis for the transaction's counterparty address. | | `alerts` | Array of objects | Transaction-level alerts triggered by Chainalysis (when applicable). | | `alertsAnswer` | String (Enum) | Sumsub-derived answer aggregated over `alerts`: `GREEN`, `YELLOW`, `RED`, `ERROR`, or `IGNORED`. | | `alertsRiskLevelRaw` | String | Risk level in Chainalysis notation (for example, `Low`, `Medium`, `High`, `Severe`). | ## `chainalysisMonitorData.addressAlert` attributes | Field | Type | Description | | ----------------- | --------------------------------------------------------------- | ------------------------------------------------------------------------------------ | | `address` | String | Address that was assessed. | | `riskLevel` | String (Enum) | Sumsub-translated risk level: `GREEN`, `YELLOW`, `RED`, `ERROR`, or `IGNORED`. | | `riskLevelRaw` | String | Risk level in Chainalysis notation (for example, `Low`, `Medium`, `High`, `Severe`). | | `reason` | String | Human-readable rationale for the assessment. | | `exposures` | Array of objects | Address's current category exposures returned by Chainalysis. | | `identifications` | Array of objects | Identifications Chainalysis has linked to the address. | | `triggers` | Array of objects | Exposure rules the address triggered. | | `cluster` | [Object](#chainalysismonitordataaddressalertcluster-attributes) | Cluster containing the address. | ## `chainalysisMonitorData.addressAlert.cluster` attributes | Field | Type | Description | | ---------- | ------ | ----------------------------------------------------------------- | | `name` | String | Cluster name (for example, `HTX.com (formerly Huobi)`). | | `category` | String | Cluster category (for example, `exchange`, `gambling`, `mixing`). | *** ## `ellipticMonitorData` attributes Result of the Elliptic screening. | Field | Type | Description | | ------------------- | ---------------------------------------------------------- | ------------------------------------------------------ | | `walletExposure` | [Object](#ellipticmonitordatawalletexposure-attributes) | Wallet-exposure analysis for the counterparty address. | | `transferScreening` | [Object](#ellipticmonitordatatransferscreening-attributes) | Transfer-screening analysis for this transaction. | ## `ellipticMonitorData.walletExposure` attributes | Field | Type | Description | | ---------------- | ------------------------------------------------ | ----------------------------------------------------------------------- | | `updatedAt` | Date | Time the analysis was last updated by Elliptic (`yyyy-MM-dd HH:mm:ss`). | | `analysisId` | String | Elliptic's identifier for this analysis. | | `riskScore` | Number | Elliptic risk score for the wallet (when available). | | `assetTier` | String (Enum) | Coverage tier: `full`, `holistic`, `none` (per Elliptic). | | `contributions` | [Array of objects](#walletexposurecontributions) | Categories contributing to the wallet's exposure. | | `triggeredRules` | Array of objects | Elliptic rules that fired against this wallet. | | `blockchainInfo` | [Object](#walletexposureblockchaininfo) | Aggregate volumes from the blockchain for this address. | | `assetSupported` | Boolean | `true` if Elliptic supports the requested asset. | ## `walletExposure.contributions[]` | Field | Type | Description | | ----------------- | -------------------------------------------- | ------------------------------------------------------------------- | | `direction` | String (Enum) | `in` (incoming) or `out` (outgoing) exposure. | | `amount` | Number | USD-valued amount of this contribution. | | `percentage` | Number | Share of the wallet's volume this contribution represents. | | `entity` | [Object](#walletexposurecontributionsentity) | Counterparty entity attributed by Elliptic. | | `minNumberOfHops` | Integer | Minimum on-chain hops between the screened address and this entity. | ## `walletExposure.contributions[].entity` | Field | Type | Description | | ---------- | ------- | -------------------------------------------------------------- | | `name` | String | Entity name (for example, `Binance`, `Unknown`). | | `category` | String | Entity category (for example, `Exchange`, `Mixer`, `Unknown`). | | `vasp` | Boolean | `true` if Elliptic classifies the entity as a VASP. | ## `walletExposure.blockchainInfo` | Field | Type | Description | | --------------- | ------ | ------------------------------------------ | | `incomingTotal` | Number | Total value received by the address (USD). | | `outgoingTotal` | Number | Total value sent by the address (USD). | ## `ellipticMonitorData.transferScreening` attributes | Field | Type | Description | | ---------------- | --------------------------------------------------- | ----------------------------------------------------------------------- | | `analysisId` | String | Elliptic's analysis identifier for this transfer. | | `answer` | String (Enum) | Sumsub-derived answer: `GREEN`, `YELLOW`, `RED`, `ERROR`, or `IGNORED`. | | `riskScore` | Number | Risk score Elliptic assigned to the transfer. | | `processStatus` | String (Enum) | Processing status (for example, `complete`, `pending`, `failed)`. | | `assetSupported` | Boolean | `true` if Elliptic supports the asset of this transfer. | | `blockchainInfo` | [Object](#transferscreeningblockchaininfo) | Blockchain context for the transfer. | | `contributions` | [Array of objects](#transferscreeningcontributions) | Per-entity contributions to the transfer risk. | ## `transferScreening.blockchainInfo` | Field | Type | Description | | ------------- | ----------------------------------------------------- | ---------------------------------------------------------- | | `address` | [Object](#transferscreeningblockchaininfoaddress) | Aggregate-level information about the address. | | `transaction` | [Object](#transferscreeningblockchaininfotransaction) | Information about the on-chain transaction. | | `value` | String | Raw transfer value as returned by Elliptic when populated. | ## `transferScreening.blockchainInfo.address` | Field | Type | Description | | ------------- | ------- | ---------------------------------------------------- | | `hasSent` | Boolean | `true` if the address has any outgoing transactions. | | `hasReceived` | Boolean | `true` if the address has any incoming transactions. | ## `transferScreening.blockchainInfo.transaction` | Field | Type | Description | | --------- | ---------------------------------------------------------- | ---------------------------------------------- | | `time` | String (ISO-8601) | UTC timestamp of the on-chain transaction. | | `inputs` | Array of objects | Transaction inputs (address-level breakdown). | | `outputs` | Array of objects | Transaction outputs (address-level breakdown). | | `value` | [Object](#transferscreeningblockchaininfotransactionvalue) | Transaction value. | ## `transferScreening.blockchainInfo.transaction.value` | Field | Type | Description | | -------------- | ------ | ---------------------------------------- | | `nativeAmount` | Number | Value in the native asset's minor units. | | `nativeMajor` | Number | Value in the native asset's major units. | | `usd` | Number | Value in USD. | ## `transferScreening.contributions[]` | Field | Type | Description | | ------------------------ | ----------------------------------------------------------- | ------------------------------------------------------------------- | | `entities` | [Array of objects](#transferscreeningcontributionsentities) | Entities contributing to this risk attribution. | | `contributionPercentage` | Number | Percentage share of the contribution to the transfer. | | `contributionValue` | Object | USD value of the contribution. | | `counterpartyPercentage` | Number | Percentage share attributed to the counterparty. | | `counterpartyValue` | Object | USD value attributed to the counterparty. | | `indirectPercentage` | Number | Percentage share attributed indirectly. | | `indirectValue` | Object | USD value attributed indirectly. | | `isScreenedAddress` | Boolean | `true` if this contribution is the screened address itself. | | `minNumberOfHops` | Integer | Minimum on-chain hops between the screened address and this entity. | ## `transferScreening.contributions[].entities[]` | Field | Type | Description | | ----------------- | ------- | ---------------------------------------------------------- | | `name` | String | Entity name (for example, `HTX (formerly Huobi)`). | | `category` | String | Entity category (for example, `Exchange`, `Mixer`). | | `categoryId` | String | Elliptic category identifier (UUID). | | `entityId` | String | Elliptic entity identifier (UUID). | | `actorId` | Integer | Elliptic actor identifier. | | `isPrimaryEntity` | Boolean | `true` if this is the primary entity for the contribution. | | `isVasp` | Boolean | `true` if classified as a VASP by Elliptic. | *** ## `trmLabsMonitorData` attributes Result of the TRM Labs screening. | Field | Type | Description | | ------------------- | --------------------------------------------------------- | ----------------------------------------------------- | | `walletScreening` | [Object](#trmlabsmonitordatawalletscreening-attributes) | Wallet-screening result for the counterparty address. | | `transferScreening` | [Object](#trmlabsmonitordatatransferscreening-attributes) | Transfer-screening result for this transaction. | ## `trmLabsMonitorData.walletScreening` attributes | Field | Type | Description | | ----------------------------------- | --------------------------------------------------------- | ------------------------------------------------------------------------------------------ | | `answer` | String (Enum) | Sumsub-derived answer: `GREEN`, `YELLOW`, `RED`, `ERROR`, or `IGNORED`. | | `assetSupported` | Boolean | `true` if TRM Labs supports the requested asset/chain. | | `accountExternalId` | String | External account ID submitted by Sumsub. | | `accountUuid` | String | TRM Labs account UUID. | | `address` | String | Wallet address that was screened. | | `addressIncomingVolumeUsd` | String | Total incoming volume to the address (USD). | | `addressOutgoingVolumeUsd` | String | Total outgoing volume from the address (USD). | | `addressHighestRiskScoreLevel` | Integer | Highest risk-score level observed across all indicators (TRM scale). | | `addressHighestRiskScoreLevelLabel` | String | Label for `addressHighestRiskScoreLevel` (for example, `Low`, `Medium`, `High`, `Severe`). | | `addressRiskIndicators` | [Array of objects](#walletscreeningaddressriskindicators) | Risk indicators contributing to the address's risk profile. | | `addressSubmitted` | String | The address as it was submitted to TRM Labs. | | `addressTotalVolumeUsd` | String | Total volume seen on the address (USD). | | `chain` | String | TRM Labs chain identifier (for example, `bitcoin`, `ethereum`). | | `entities` | [Array of objects](#walletscreeningentities) | Entities TRM Labs has linked to the address. | | `externalId` | String | External screening request identifier. | | `trmAppUrl` | String | Deep-link to the address in the TRM Labs UI. | ## `walletScreening.addressRiskIndicators[]` | Field | Type | Description | | ----------------------------- | ------- | --------------------------------------------------------------- | | `category` | String | Risk category (for example, `High-Risk Exchange`, `Sanctions`). | | `categoryId` | String | TRM category identifier. | | `categoryRiskScoreLevel` | Integer | Risk-score level for this category (TRM scale). | | `categoryRiskScoreLevelLabel` | String | Label for `categoryRiskScoreLevel`. | | `incomingVolumeUsd` | String | Incoming volume contributed by this category (USD). | | `outgoingVolumeUsd` | String | Outgoing volume contributed by this category (USD). | | `riskType` | String | Risk type (for example, `OWNERSHIP`, `INDIRECT`). | | `totalVolumeUsd` | String | Total volume contributed by this category (USD). | | `incomingVolumePercent` | String | Share of incoming volume from this category. | | `outgoingVolumePercent` | String | Share of outgoing volume from this category. | | `totalVolumePercent` | String | Share of total volume from this category. | ## `walletScreening.entities[]` | Field | Type | Description | | ---------------------- | ------- | ------------------------------------------------------------- | | `category` | String | Entity category (for example, `High-Risk Exchange`, `Mixer`). | | `categoryId` | String | TRM category identifier. | | `confidenceScoreLabel` | String | Confidence label (for example, `Near Certainty`, `High`). | | `entity` | String | Entity name. | | `riskScoreLevel` | Integer | Entity-level risk score. | | `riskScoreLevelLabel` | String | Label for `riskScoreLevel`. | | `trmAppUrl` | String | Deep-link to the entity in the TRM Labs UI. | | `trmUrn` | String | TRM URN identifying the entity. | ## `trmLabsMonitorData.transferScreening` attributes | Field | Type | Description | | -------------------------- | -------------------------------------------- | ----------------------------------------------------------------------- | | `answer` | String (Enum) | Sumsub-derived answer: `GREEN`, `YELLOW`, `RED`, `ERROR`, or `IGNORED`. | | `assetSupported` | Boolean | `true` if TRM Labs supports this asset/chain. | | `accountExternalId` | String | External account identifier submitted by Sumsub. | | `accountUuid` | String | TRM Labs account UUID. | | `alerts` | [Array of objects](#transferscreeningalerts) | Alerts TRM Labs raised for this transfer. | | `asset` | String | Asset code (for example, `btc`, `eth`). | | `assetAmount` | String | Transfer amount in the asset's native units. | | `chain` | String | TRM Labs chain identifier. | | `destinationAddress` | String | Destination address of the transfer. | | `externalId` | String | External transfer identifier. | | `fiatCurrency` | String | Fiat currency for `fiatValue`. | | `fiatValue` | String | Transfer value in fiat. | | `onchainReference` | String | On-chain transaction reference (txid). | | `riskScoreLevel` | Integer | Overall transfer risk-score level. | | `riskScoreLevelLabel` | String | Label for `riskScoreLevel`. | | `screenStatus` | String (Enum) | Screening status (for example, `SUCCEEDED`, `PENDING`, `FAILED)`. | | `screenStatusFailedReason` | String | Reason if `screenStatus` is `FAILED`. | | `submittedAt` | String (ISO-8601) | UTC timestamp the screening was submitted. | | `timestamp` | String (ISO-8601) | UTC timestamp of the on-chain transfer. | | `transferType` | String (Enum) | Transfer type (for example, `CRYPTO_DEPOSIT`, `CRYPTO_WITHDRAWAL)`. | | `trmAppUrl` | String | Deep-link to the transfer in the TRM Labs UI. | | `uuid` | String | TRM Labs transfer UUID. | ## `transferScreening.alerts[]` | Field | Type | Description | | --------------------------- | ----------------- | ------------------------------------------------- | | `accountUuid` | String | TRM account UUID, when applicable. | | `closedAt` | String (ISO-8601) | UTC timestamp the alert was closed. | | `closedJustification` | String | Justification recorded when the alert was closed. | | `closedReason` | String | Reason recorded when the alert was closed. | | `issuedAt` | String (ISO-8601) | UTC timestamp the alert was issued. | | `valid` | Boolean | `true` if the alert is currently valid. | | `ownedByUserEmail` | String | Email of the user who owns the alert. | | `riskScoreLevel` | Integer | Alert risk-score level. | | `riskScoreLevelLabel` | String | Label for `riskScoreLevel`. | | `ruleUuid` | String | Identifier of the TRM rule that fired. | | `status` | String (Enum) | Alert status (`OPEN`, `CLOSED`, and so on). | | `statusUpdatedAt` | String (ISO-8601) | UTC timestamp the status was last updated. | | `statusUpdatedByUserEmail` | String | Email of the user who last updated the status. | | `transferAccountExternalId` | String | External account ID of the transfer. | | `transferExternalId` | String | External transfer ID. | | `transferUuid` | String | TRM transfer UUID. | | `trmAppUrl` | String | Deep-link to the alert in the TRM Labs UI. | | `updatedAt` | String (ISO-8601) | UTC timestamp the alert was last updated. | | `updatedByUserEmail` | String | Email of the user who last updated the alert. | | `uuid` | String | Alert UUID. | *** ## `merkleMonitorData` attributes Result of the Merkle Science screening. | Field | Type | Description | | ------------------- | -------------------------------------------------------- | ----------------------------------------------------- | | `walletScreening` | [Object](#merklemonitordatawalletscreening-attributes) | Wallet-screening result for the counterparty address. | | `transferScreening` | [Object](#merklemonitordatatransferscreening-attributes) | Transfer-screening result for this transaction. | ## `merkleMonitorData.walletScreening` attributes | Field | Type | Description | | ------------------------- | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | `assetSupported` | Boolean | `true` if Merkle Science supports the requested asset. | | `identifier` | String | Wallet address that was screened. | | `blockchain` | Integer | Merkle blockchain numeric identifier. | | `blockchainVerbose` | String | Human-readable blockchain name (for example, `Bitcoin`). | | `customerId` | String | Customer identifier passed to Merkle. | | `type` | Integer | Address type (Merkle code). | | `typeVerbose` | String | Human-readable address type. | | `totalIncomingValue` | String | Total incoming value in native units. | | `totalIncomingValueUsd` | String | Total incoming value in USD. | | `totalOutgoingValue` | String | Total outgoing value in native units. | | `totalOutgoingValueUsd` | String | Total outgoing value in USD. | | `balance` | String | Current balance in native units. | | `earliestTransactionTime` | String (ISO-8601) | Earliest observed transaction time. | | `latestTransactionTime` | String (ISO-8601) | Latest observed transaction time. | | `riskLevel` | Integer | Merkle risk-level code (`0`–`5`). | | `riskLevelVerbose` | String | Risk-level label (for example, `No Risk Detected`, `Low`, `Medium`, `High`, `Severe`). | | `createdAt` | String (ISO-8601) | UTC timestamp the Merkle record was created. | | `updatedAt` | String (ISO-8601) | UTC timestamp the Merkle record was last updated. | | `originator` | [Array of objects](#walletscreeningoriginator-and-walletscreeningbeneficiary) | Exposure breakdown of incoming counterparties. | | `beneficiary` | [Array of objects](#walletscreeningoriginator-and-walletscreeningbeneficiary) | Exposure breakdown of outgoing counterparties. | | `tags` | [Object](#walletscreeningtags) | Owner / user tags assigned by Merkle. | | `customTags` | Array of strings | Custom tags supplied to or maintained by Merkle. | | `digitalAssets` | [Array of objects](#walletscreeningdigitalassets-elements) | Digital assets observed on this address. | ## `walletScreening.originator[]` and `walletScreening.beneficiary[]` | Field | Type | Description | | ------------------- | ------------- | --------------------------------------------------------- | | `tagTypeVerbose` | String | High-level tag type (for example, `Exchange`, `Mixer`). | | `tagSubTypeVerbose` | String | Tag subtype (for example, `Mandatory KYC and AML`). | | `tagNameVerbose` | String | Specific tag name (for example, `Bitstamp`, `Huobi.com`). | | `totalValueUsd` | String | USD value attributed to this counterparty. | | `exposureType` | String (Enum) | `direct` or `indirect`. | ## `walletScreening.tags` | Field | Type | Description | | ------- | ------------------------------------------------------------ | ------------------------------------------------------------------------------ | | `owner` | [Object](#walletscreeningtagsowner--walletscreeningtagsuser) | Tag describing the owner of the address (for example, the operating exchange). | | `user` | [Object](#walletscreeningtagsowner--walletscreeningtagsuser) | Tag describing the user of the address, when applicable. | ## `walletScreening.tags.owner` / `walletScreening.tags.user` | Field | Type | Description | | ------------------- | ------ | -------------------- | | `tagTypeVerbose` | String | High-level tag type. | | `tagSubTypeVerbose` | String | Tag subtype. | | `tagNameVerbose` | String | Specific tag name. | ## `walletScreening.digitalAssets[]` elements | Field | Type | Description | | -------- | ------ | ------------------------------------ | | `name` | String | Asset name (for example, `Bitcoin`). | | `symbol` | String | Asset symbol (for example, `BTC`). | ## `merkleMonitorData.transferScreening` attributes | Field | Type | Description | | ------------------- | --------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | `assetSupported` | Boolean | `true` if Merkle Science supports the requested asset. | | `identifier` | String | On-chain transaction reference (txid). | | `blockchain` | Integer | Merkle blockchain numeric identifier. | | `blockchainVerbose` | String | Human-readable blockchain name. | | `customerId` | String | Customer identifier passed to Merkle. | | `type` | Integer | Transaction type (Merkle code). | | `typeVerbose` | String | Human-readable transaction type. | | `address` | String | Counterparty address involved in the transfer. | | `value` | String | Transfer value in native units. | | `valueUsd` | String | Transfer value in USD. | | `fee` | String | Network fee in native units. | | `feeUsd` | String | Network fee in USD. | | `riskLevel` | Integer | Merkle risk-level code (`0`–`5`). | | `riskLevelVerbose` | String | Risk-level label (for example, `No Risk Detected`, `Low`, `Medium`, `High`, `Severe`). | | `blockTimestamp` | String (ISO-8601) | UTC timestamp of the on-chain block. | | `createdAt` | String (ISO-8601) | UTC timestamp the Merkle record was created. | | `updatedAt` | String (ISO-8601) | UTC timestamp the Merkle record was last updated. | | `digitalAssets` | [Array of objects](#transferscreeningdigitalassets) | Digital assets present in the transfer. | | `originator` | [Array of objects](#transferscreeningoriginator-and-transferscreeningbeneficiary) | Originator-side counterparties and exposure. | | `beneficiary` | [Array of objects](#transferscreeningoriginator-and-transferscreeningbeneficiary) | Beneficiary-side counterparties and exposure. | ## `transferScreening.digitalAssets[]` | Field | Type | Description | | ---------- | ------ | ------------------------------------ | | `name` | String | Asset name (for example, `Bitcoin`). | | `symbol` | String | Asset symbol (for example, `BTC`). | | `value` | String | Asset amount in native units. | | `valueUsd` | String | Asset value in USD. | ## `transferScreening.originator[]` and `transferScreening.beneficiary[]` | Field | Type | Description | | ------------------- | ------------- | ---------------------------------------------- | | `tagTypeVerbose` | String | High-level tag type (for example, `Exchange`). | | `tagSubtypeVerbose` | String | Tag subtype. | | `tagNameVerbose` | String | Specific tag name. | | `totalValueUsd` | String | USD value attributed to this counterparty. | | `exposureType` | String (Enum) | `direct` or `indirect`. | ***
# 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/txns/-;data.txnId={txnId}/one": { "get": { "summary": "Get transaction information by `txnId`", "description": "", "operationId": "get-transaction-information-by-txnid", "parameters": [ { "name": "txnId", "in": "path", "description": "Unique transaction identifier in your system (alphanumeric).", "schema": { "type": "string" }, "required": true } ], "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```