Approve or reject transaction

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

Use this method to approve or reject a transaction.

Request examples

curl -X POST \
    'https://api.sumsub.com/resources/kyt/txns/631f268442d8290001e1eee8/review/status/completed' \
    -H 'Content-Type: application/json' \
    -H 'X-App-Token: <your-app-token>' \
    -H 'X-App-Access-Sig: <your-signature>' \
    -H 'X-App-Access-Ts: <unix-timestamp>' \
    -d '{
          "reviewAnswer": "GREEN"
        }'
curl -X POST \
    'https://api.sumsub.com/resources/kyt/txns/631f268442d8290001e1eee8/review/status/completed' \
    -H 'Content-Type: application/json' \
    -H 'X-App-Token: <your-app-token>' \
    -H 'X-App-Access-Sig: <your-signature>' \
    -H 'X-App-Access-Ts: <unix-timestamp>' \
    -d '{
          "reviewAnswer": "RED"
        }'

Response explained

The response is a JSON file that represents the full and structured transaction data. See the response structure, possible content with descriptions on the following page.

Response example

{
  "id": "66335d9a243caf315d8c36ef",
  "applicantId": "662edfdb7a26397a65d3bdc6",
  "externalUserId": "PlatformEvent0001",
  "clientId": "korban.inc",
  "data": {
    "txnId": "general0001",
    "txnDate": "2024-04-29 02:30:12+0000",
    "applicant": {
      "externalUserId": "PlatformEvent0001",
      "fullName": "Users Fullname",
      "address": {
        "flatNumber": "usersAddFlatNumber",
        "subStreet": "usersAddSbSt",
        "street": "usersAddSt",
        "state": "usersAddState",
        "buildingNumber": "usersAddBuildNum",
        "town": "usersAddressTown",
        "postCode": "000000",
        "country": "CAN",
        "formattedAddress": "usersAddSt, usersAddSbSt usersAddBuildNum usersAddFlatNumber, usersAddressTown, usersAddState, Canada, 000000"
      },
      "type": "individual",
      "device": {
        "ipInfo": {
          "ip": "242.1.1",
          "riskyAsn": false
        },
        "userAgent": "usersDeviceUA",
        "sessionId": "usersDeviceSesId",
        "sessionAgeMs": 18,
        "acceptLang": "en",
        "coords": {
          "lat": -1.7976931348623157,
          "lon": 1.7976931348623157,
          "accuracy": 10
        },
        "fingerprint": "usersDeviceFing"
      }
    },
    "type": "userPlatformEvent",
    "userPlatformEventInfo": {
      "type": "general"
    }
  },
  "score": 0,
  "review": {
    "reviewId": "XvSHf",
    "attemptId": "QaUMN",
    "attemptCnt": 1,
    "elapsedSincePendingMs": 149,
    "elapsedSinceQueuedMs": 149,
    "createDate": "2024-05-02 09:32:10+0000",
    "reviewResult": {
      "reviewAnswer": "GREEN"
    },
    "reviewStatus": "completed"
  },
  "createdAt": "2024-05-02 09:32:10+0000",
  "scoringResult": {
    "score": 0,
    "dryScore": 0,
    "matchedRules": [
      {
        "id": "6602a0f43d40c8131dc4e17a",
        "name": "AFP1-agg-beh-eve-for-user-pla-eve-BBKP",
        "revision": 1,
        "title": "Aggregate behavioral events for user platform events",
        "score": 0,
        "dryRun": false,
        "action": "score",
        "stage": "pre",
        "preScoringRunnerType": "behavioralEvents"
      }
    ],
    "unmatchedRules": [],
    "action": "score",
    "ruleCnt": 2,
    "dryRunRuleCnt": 0,
    "tagScores": []
  },
  "typedTags": [],
  "txnInactive": false
}

Path Params
string
required

Unique transaction identifier in the Sumsub system.

This ID is returned in the response to this request and a webhook (kytTxnId). Save it for future use in subsequent API calls. Alternatively, you can get this identifier by the following method.

Body Params
string
enum
required
Defaults to GREEN

Set the review answer.

  • GREEN — to approve the transaction.
  • RED — to reject the transaction.

Allowed:
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here!