Overview

Use this method to retrieve transaction information by a known transaction ID in the Sumsub system.

To get transaction information by externalTxnId (a transaction ID on your side), use the following method instead.

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.

Below, you can see the response structure and possible content with descriptions:

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	A unique transaction identifier in the Sumsub system.
`applicantId`	String	A 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	A unique transaction participant identifier as it is registered on your side.
`clientId`	String	A 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	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	A transaction score based on the triggered rules.
`review`	Object	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	Includes an overall scoring result and its details.
`txnInactive`	Boolean	If this field returns `true`, the applicant profile associated with the transaction is deleted.

`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	The transaction ID (`externalTxnId`) as it is on your side.
`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	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	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	A transaction type. Expects values: `finance`(default) `gamblingBet` `gamblingLimitChange` `gamblingBonusChange` `kyc` `travelRule` `userPlatformEvent` `login` `signup` `passwordChange` `twoFaReset`
`info`	Object	Transaction-related financial information.
`props`	Map of strings	A 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	A unique applicant identifier as it is registered on your side. You can generate and add it manually when creating an applicant. If not, the external user ID is added automatically.
`fullName`	String	The applicant’s full name.
`address`	Object	The applicant's actual address details (if provided).
`type`	Enum	The applicant's entity type: `individual` or `company`.
`paymentMethod`	Object	A payment method used by the applicant.
`paymentMethodExtractedInfo`	Object	Payment method information extracted from available data.
`device`	Object	Technical data of the device used by the applicant to complete a transaction.
`institutionInfo`	Object	Information regarding the financial institution through which the applicant made a transaction.
`institutionExtractedInfo`	Object	Financial institution information extracted from available data. Stands for BIC country.

`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	A unique user identifier as it is registered on your side.
`fullName`	String	The counterparty's full name.
`address`	Object	The counterparty's actual address details (if provided).
`type`	Enum	The counterparty's entity type: `individual` or `company`.
`paymentMethod`	Object	A payment method used by a counterparty.
`paymentMethodExtractedInfo`	Object	Payment method information extracted from available data.
`device`	Object	Technical data of the device used by a counterparty to complete a transaction.
`institutionInfo`	Object	Information regarding the financial institution through which a counterparty made a transaction.
`institutionExtractedInfo`	Object	Financial institution information extracted from available data. Stands for BIC country.

`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
`country`	String	A country code (ISO 3166-1 alpha-3). For example, `DEU`, `GBR`, `ARG`, and so on.
`formattedAddress`	String	Address in a human-readable format.
`state`	String	The state, region, district, county or another territorial entity inside a country.
`town`	String	The city, town, or another settlement.
`street`	String	The street name.

`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: `card` / `account` / `crypto`.
`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.

`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	Includes the data related to the used IP address.
`userAgent`	String	A device user-agent.
`sessionId`	String	An ID of the transaction session.
`sessionAgeMs`	Long	The session lifetime in milliseconds.
`acceptLang`	String	A language of the browser used by a transaction participant, e.g. `en`.
`platform`	String	A device platform, e.g. `Mobile Android`.
`coords`	Object	Geographical coordinates.
`address`	Object	The address related to a device.
`fingerprint`	String	A device fingerprint.

`ipInfo` attributes

This table explains the data elements associated with the IP address.

Field	Type	Description
`ip`	String	An IP address.
`countryCode2`	String	A country code (ISO 3166-1 alpha-2).
`countryCode3`	String	A country code (ISO 3166-1 alpha-3).
`city`	String	The city the IP address belongs to.
`zipCode`	String	A ZIP code.
`lat`	Double	Represents the position's latitude in decimal degrees.
`lon`	Double	Represents the position's longitude in decimal degrees.
`asn`	Integer	The 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	A transaction institution code, e.g. BIC.
`name`	String	A transaction institution name.
`address`	Object	A transaction institution address.
`vasp`	Object	Directory information about VASP (Virtual Asset Service Provider).

`vasp` attributes

The following table explains the VASP (Virtual Asset Service Provider) directory information.

Field	Type	Description
`countries`	String	The list of all the registration countries for legal entities of the VASP.
`regulationType`	Enum	Represents the type of regulation (`authorized` / `temporaryExemption` / `unauthorized`) for VASP (Virtual Asset Service Provider).
`essentialChecksStatus`	Enum	Indicates the Essential Checks (EC) status: `initiated` — the VASP has just been added and is yet to complete any checks. `essentialChecksDone` — the VASP for which Sumsub has only the information from blockchain analytics. `extendedEssentialChecksDone` — Extended Essential Checks (EEC) have been passed. `rejected` — the VASP is rejected due to a number of reasons.
`dueDiligenceStaus`	Enum	Indicates the status of the Due Diligence process: `notStarted` — the Due Diligence process has not been yet begun. `inProgress` — the Due Diligence process is underway. `completed` — the VASP has passed Due Diligence. `rejected` — the VASP is rejected due to a number of reasons. Note that a VASP with Due Diligence `completed` will have either `essentialChecksDone` or `extendedEssentialChecksDone` status as well.
`riskScoreAnswer`	Enum	Data based on the vendor information about VASP type: `GREEN` — if the VASP type is `exchange_licensed` `YELLOW` — if the VASP type is `exchange_unlicensed`, `payment`, `other`, `atm`, `p2p_exchange_unlicensed`, `marketplace`, `liquidity_pools`, `transparent`, `gambling`. `ERROR` — no data received from the provider. `RED` — otherwise.
`emailExists`	Boolean	There is an email address on the VASP profile.
`urlExists`	Boolean	There is a website address on the VASP profile.
`score`	Double	There is a score on the VASP profile based on EEC (Extended Essential Checks).

`data.info` attributes

The following table explains the transaction-related financial information.

Field	Type	Description
`direction`	String	The direction in which the funds are transferred. `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	A code of the currency in which the transaction was made.
`currencyType`	String	Indicates whether the transaction is `crypto` or `fiat`.
`amountInDefaultCurrency`	Double	A transaction amount in the default currency.
`defaultCurrencyCode`	String	A code of the default currency.
`paymentDetails`	String	A comment with the details of payment.

`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`	Integer	Elapsed time since the transaction check passed to the `pending` status.
`createDate`	Date	Date and time (UTC) when the transaction was created in the Sumsub system.
`reviewDate`	Date	Date and time (UTC) when the transaction check was completed.
`reviewResult`	Object	Contains the `reviewAnswer` parameter that explains the transaction review result. `GREEN` — the transaction is approved. `RED` — the transaction is declined.
`reviewStatus`	String	Indicates the applicant review status.
`confirmed`	Boolean	Indicates whether the officer has confirmed the verdict on the transaction as defined by the rules.

`scoringResult` attributes

The following table explains the transaction overall scoring result and its details.

Field	Type	Description
`score`	Integer	The calculated score of a transaction.
`dryScore`	Integer	The calculated dry score of the transaction which would be assigned by the rules applied in the dry run mode.
`matchedRules`	Array of objects	All 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	A total number of the rules counted for a transaction.
`dryRunRuleCnt`	Integer	A total number of the dry run rules counted for a transaction.

`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`).

Overview

Response explained

Root variables

data attributes

data.applicant attributes

data.counterparty attributes

address attributes

paymentMethod attributes

device attributes

ipInfo attributes

coords attributes

institutionInfo and institutionExtractedInfo attributes

vasp attributes

data.info attributes

review attributes

scoringResult attributes

matchedRules element fields