Overview

Use this method to get the list of applicant actions for a particular applicant.

Get applicant actions by txnId

To retrieve applicant actions linked to a particular transaction, include a unique transaction identifier (kytTxnReference.txnId={txnId}) from the Sumsub system in your request. By using this parameter, the response will exclusively return applicant actions associated with the specified transaction, excluding all other actions.

Request example

curl -X GET \
  'https://api.sumsub.com/resources/applicantActions/-;applicantId=5e5f9ab10a975a6e224dc286;kytTxnReference.txnId=6659fbf0ca1da20df53caa71?limit=10&offset=0'

Response explained

The response is a JSON file that represents the list of all applicant actions.

• Root variables
• items
  • review
  • checks
  • docSets
  • agreement
  • paymentMethod
    • data
  • paymentSource
    • info and fixedInfo
    • checks (paymentSource.checks)
  • images
    • idDocDef
  • reviewResult
• Response example

Root variables

The root variables represent the list of available applicant actions and their total number.

items element fields

The following table explains the items element fields representing the attributes and configuration details of applicant actions. Some of the items may include nested attributes and element fields.

review attributes

The following table explains the review object attributes that represent the details of the applicant action status and check result.

checks element fields

The following table explains the details of the checks performed within the action.

docSets element fields

The following table explains the element fields of the docSets array representing specific document sets and their attributes.

agreement attributes

The following table explains the details of the applicant consent to the submitting and processing of personal data.

paymentMethod attributes

The following table explains the details of the payment method configured on the level and used by the applicant.

data attributes

The following table explains the payment method details recognized from the documents.

paymentSource attributes

The following table explains the details of the payment source checks.

info and fixedInfo attributes

The following table explains the info and fixedInfo objects that include the payment source data extracted from the documents and provided data respectively.

checks (paymentSource.checks) element fields

The following table explains the details of the payment source checks.

bankCardRiskScoreInfo attributes

The following table explains the information related to the risk score of the bank card.

binInfo attributes

The following table explains the information that relates to the bank card and the issuing bank.

images element fields

The following table explains the images element fields including the information about each document image and the review result regarding the specified image.

idDocDef attributes

The following table explains the idDocDef attributes representing the additional information about the document.

reviewResult attributes

The following table includes the reviewResult attributes explaining the action check result details.

Response example

{
  "list" : {
    "items" : [ {
      "id" : "5dd3f15704f9400000000000", // applicant action identifier
      "createdAt" : "2019-11-19 13:42:47",
      "applicantId" : "5dd3d58304f9400000000000",
      // ...
    }, {
      "id" : "5dd3d94153d4860000000000", // applicant action identifier
      "createdAt" : "2019-11-19 12:00:01",
      "applicantId" : "5dd3d58304f9400000000000",
      // ...
    } ],
    // total number of applicant actions (even if a limit is provided)
    "totalItems" : 213
  }
}

You can see an example of the single action structure on the following page.