SUsumsub

Submit transaction

Changed on
post/resources/applicants/{applicantId}/kyt/txns/-/data

Request

Path parameters

applicantIdstring required

Unique identifier of the applicant who passed user verification (KYC). If you do not have such an applicant, use Submit transaction for non-existing applicant instead.

Request body

txnIdstring required

Unique transaction identifier in your system (alphanumeric). <br><br>Note: If the specified txnId already exists, a 409 error code "Duplicate txnId: <txnId>" is returned.

txnDatestring date-time

Date and time of performing a transaction. <br><br>Format: yyyy-MM-dd HH:mm:ss+XXXX, for example, 2022-11-24 23:37:02+0000.<br><br>⚠️ 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.

zoneIdstring

Time zone identifier on your side provided in a form of prefix and offset, e.g., UTC+01:00. <br><br>Required to calculate the txnLocalDate expression attribute value that is a transaction creation date in your provided timezone. If not provided, UTC is used by default.

type'finance' | 'kyc' | 'travelRule' | 'userPlatformEvent' required

Transaction type.

sourceKeystring

Source key indication to separate access to transactions.

Response

200

OR
OR
OR
OR
OR
OR
OR

Example response

{
  "id": "66335c8c243caf315d8c357c",
  "applicantId": "662edfdb7a26397a65d3bdc6",
  "scope": "events",
  "externalUserId": "PlatformEvent0001",
  "clientId": "korban.inc",
  "data": {
    "txnId": "twoFaReset0001",
    "txnDate": "2024-04-29 02:30:12+0000",
    "type": "userPlatformEvent",
    "applicant": {
      "externalUserId": "PlatformEvent0001",
      "fullName": "Users Fullname",
      "placeOfBirth": "settlementName",
      "dob": "1995-09-30",
      "address": {
        "buildingName": "usersAddBuildName",
        "flatNumber": "101",
        "subStreet": "usersAddSbSt",
        "subStreetEn": "usersAddSbStEn",
        "street": "usersAddSt",
        "streetEn": "usersAddStEn",
        "state": "usersAddState",
        "stateEn": "usersAddStateEn",
        "buildingNumber": "202",
        "town": "usersAddressTown",
        "townEn": "usersAddressTownEn",
        "postCode": "123456",
        "country": "CAN",
        "formattedAddress": "postCode, town, state, street, buildingNumber"
      },
      "type": "individual",
      "device": {
        "ipInfo": {
          "ip": "178.123.68.138"
        },
        "userAgent": "usersDeviceUA",
        "sessionId": "usersDeviceSesId",
        "sessionAgeMs": 18,
        "acceptLang": "en",
        "coords": {
          "lat": -1.7976931348623157,
          "lon": 1.7976931348623157,
          "accuracy": 10
        },
        "fingerprint": "usersDeviceFing"
      },
      "paymentMethodExtractedInfo": {
        "type": "smartContract"
      }
    },
    "userPlatformEventInfo": {
      "type": "twoFaReset"
    },
    "props": {
      "customProperty": "Custom value",
      "dailyOutLimit": "10000"
    }
  },
  "review": {
    "reviewId": "azlir",
    "attemptId": "RPgcu",
    "attemptCnt": 1,
    "elapsedSincePendingMs": 238,
    "elapsedSinceQueuedMs": 238,
    "createDate": "2024-05-02 09:27:40+0000",
    "reviewResult": {
      "reviewAnswer": "GREEN"
    },
    "reviewStatus": "completed"
  },
  "createdAt": "2024-05-02 09:27:40+0000",
  "scoringResult": {
    "matchedRules": [
      {
        "id": "6602a0f43d40c8131dc4e17a",
        "name": "AFP1-agg-beh-eve-for-user-pla-eve-BBKP",
        "revision": 1,
        "title": "Aggregate behavioral events for user platform events",
        "action": "score",
        "stage": "pre",
        "preScoringRunnerType": "behavioralEvents"
      }
    ],
    "action": "score",
    "ruleCnt": 2
  }
}

Changes

  • fcc702e558a2Revision changes
    • breaking

      request property / was restricted to a list of enum values

    • breaking

      the request property became required

    • breaking

      the request property // became required

    • breaking

      the request property / became required

    • breaking

      the request property / became required

    • breaking

      the request property / became required

    • warning

      removed the request property /

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      the request property / became optional

    • info

      added the new crypto enum value to the request property /

    • info

      added the new fiat enum value to the request property /