Get action information

Returns the information about the specified applicant action.

Overview

Use this method to get the information about the specified applicant action.

Request example

curl -X GET \
     'https://api.sumsub.com/resources/applicantActions/668cc68dbd53cc0000000000/one'

Response explained

The response is a JSON file that represents the applicant action with augmented and structured information.

Root variables

The root variables are the core data items of the applicant action. Some of the items may include nested attributes and element fields.

FieldTypeDescription
idStringUnique identifier of the applicant action in the Sumsub system.
createdAtDateDate and time (UTC) the action was initiated.
clientIdStringUnique identifier of you as our client in the Sumsub system.
externalActionIdStringIdentifier of the applicant action on your side.
applicantIdStringUnique applicant identifier in the Sumsub system.
reviewObjectRepresents a review answer with additional information.
checksArray of objectsA list of checks performed within this action and their details.
requiredIdDocsObjectContains the docSets array of objects.
agreementObjectContains information about the applicant consent to submitting and processing the personal data.
paymentMethodObjectIncludes the details of the payment method configured on the action level and used by the applicant.
paymentSourceObjectIncludes the details of the payment source checks.
imagesArray of objectsA list of images attached to the action.
reviewResultObjectContains extra details of the applicant action check result.

review attributes

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

FieldTypeDescription
reviewIdStringUnique identifier of the applicant action review in the Sumsub system.
attemptIdStringUnique identifier of the current action check attempt.

Applicants may initiate several attempts to get verified if, for example, they failed once or changed/added the documents, or you could change the verification level to start another check.
attemptCntIntegerCounting number of the current action check attempt on the same verification level.
elapsedSincePendingMsIntegerElapsed time since the applicant action check passed to the pending status.
levelNameStringName of the verification level with the action an applicant has to complete.
createDateDateDate and time (UTC) when the action check was launched.
reviewResultObjectContains extra details of the applicant action check result.
reviewStatusStringIndicates the applicant action review status.

checks element fields

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

FieldTypeDescription
answerStringIndicates the action check result (GREEN, RED, ERROR).
checkTypeStringType of check (PAYMENT_METHOD, FACE_LIVENESS, and FACE_MATCH are available).
createdAtDateDate and time (UTC) the applicant action check started in the Sumsub system.
idStringUnique identifier of the applicant action check.
attemptIdStringUnique identifier of the current action check attempt.

Applicants may initiate several attempts to get verified if, for example, they failed once or changed/added the documents, or you could change the verification level to start another check.
errorMessageStringMessage explaining the error if any occurred during the check.

docSets element fields

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

FieldTypeDescription
idDocSetTypeStringA human-readable identifier of the document set type, for example, IDENTITY, SELFIE, PROOF_OF_RESIDENCE, and so on.
fieldsArray of objectsIncludes the objects describing the document data fields that should be filled with personal information to verify the applicant.

Each object contains the following attributes:
  • name (String) — the field name, for example, firstName, lastName, email, and so on.
  • required (Boolean) — true if the field is required for verification, false if not (still, it can be optionally filled in the SDK).
typesArray of stringsIncludes the types of documents that are required for a particular idDocSetType to pass verification.
videoRequiredStringMethod of passing the document upload step that can be set up when configuring a verification level.
  • disabled — selfie with a document.
  • enabled — video selfie with a phrase.
  • photoRequired — web camera photo (still face image).
  • passiveLivenessliveness check.
  • docapture — enables the camera for the steps with ID documents.
captureModeStringThis mode is applied in case the docapture method is used (see the table row above).
  • manualAndAuto — allows both to automatically capture the photo of a document when the camera is initialized, and for the applicant to hit a button to take a photo.
  • manualOnly — allows only manually hitting a button to take a photo.
uploaderModeStringThis mode is applied in case the docapture method is used.
  • always — always allows uploading a ready-made photo instead of using a camera.
  • never — does not allow uploading a ready-made photo.
  • fallback — allows uploading a ready-made photo only if a camera is not available.
questionnaireDefIdStringIdentifier of the questionnaire that is added to the verification level and is to be or has already been filled by the applicant.

agreement attributes

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

FieldTypeDescription
createdAtDateDate and time (GMT) when the applicant confirmed his/her consent to the submitting and processing of personal data.
sourceStringSpecifies the source from which the applicant confirmed the agreement (WebSDK, MSDK).

paymentMethod attributes

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

FieldTypeDescription
typeStringPayment method type (bankCard, crypto, etc.).
subTypeStringMore precise specification of the payment method type. For example, VISA, MASTERCARD for bank cards, BTC, ETH for crypto.
dataObjectRepresents specific payment method details recognized from the documents. requiredIdDoc contains the same information as data for comparison with recognized image data from the end user.
imageIdsArray of stringsUnique image identifiers. There can be several identifiers if, for example, two sides of the bank card were uploaded.

data attributes

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

FieldTypeDescription
firstNameStringFirst name.
lastNameStringLast name.
middleNameStringMiddle name.
numberStringPayment, card, or transfer number.
issuedDateDateDocument or card date of issue.
txnAmountStringTransaction amount if applicable.

paymentSource attributes

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

FieldTypeDescription
idStringUnique identifier of the payment source.
externalIdStringUnique identifier of the payment source on your side.
createdAtDateDate and time the payment source was created.
deletedBooleanIndicates if the payment source is active (false) or not (true).
fixedInfoObjectProvided information that is related to the payment source.
infoObjectExtracted information that is related to the payment source.
checksArray of objectsIncludes the data on the checks performed on the payment source and these checks’ results.

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.

FieldTypeDescription
typeStringPayment source type that can be: bankCard, bankStatement, eWallet, and cryptoWallet.
institutionNameStringName of the financial institution where an account is held (e.g., Revolut).
fullNameStringFull name of an account holder (e.g., "Alex Kim").
accountIdentifierStringUnique payment source account identifier.
validUntilDateDate until the account of the payment source is valid (format YYYY-mm-dd, e.g. 2001-09-26).

checks (paymentSource.checks) element fields

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

FieldTypeDescription
idStringUnique identifier of the payment source check.
createdAtDateDate and time (UTC) the payment source check started in the Sumsub system.
answerStringIndicates the action check result (GREEN, RED, ERROR).
unexpiredStringIndicates if the account of this payment source is valid (GREEN, RED, ERROR).
typeMatchedStringIndicates if the type of the payment source matched the data provided (GREEN, RED, ERROR).
fixedInfoMatchedStringIndicates if the payment source information matched the data provided (GREEN, RED, ERROR).
applicantInfoMatchedStringIndicates if the information in the applicant profile matched the data of the payment source account (GREEN, RED, ERROR).
unmatchedFieldsArray of stringsIncludes the applicant profile data fields that do not match with the data of the payment source account.
bankCardRiskScoreInfoObjectIncludes the information related to the risk score of the bank card.

bankCardRiskScoreInfo attributes

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

FieldTypeDescription
riskScoreDoubleRisk score based on a system analysis of the information provided.
binInfoObjectInformation that relates to the card and the issuing bank.

binInfo attributes

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

FieldTypeDescription
brandStringBrand of the payment network (e.g., VISA, Mastercard).
issuerStringName of the card issuer, usually a bank name.
typeStringCard type (e.g., debit, credit).
countryStringCountry where the card was issued. Presented as an alpha-3 country code (for example, DEU, GBR, ARG, and so on).
virtualBooleanIndicates if the bank card is virtual (true) or a standard plastic one (false).
prepaidBooleanIndicates if the bank card is prepaid (true) or a standard one (false).

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.

FieldTypeDescription
addedDateDateDate and time (UTC) when the image was uploaded.
imageHashStringChecksum of the uploaded image file.
imageFileNameStringName of the image file.
resizedImageIdStringUnique identifier of the resized image.
mimeTypeStringImage file mime-type.

The full list of mime-types and file formats, you can find in our FAQ (See the answer to What file extensions do you accept?).
imageIdStringUnique image file identifier.
actualResolutionObjectIncludes the actual width and height of the image in pixels.
answerStringIndicates the image check result (GREEN, RED, ERROR).
commentsStringComments added to the image data.
idDocDefObjectAdditional information on the document.

idDocDef attributes

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

FieldTypeDescription
countryStringAlpha-3 code (for example, DEU, GBR, ARG, and so on) of the country where the document was issued.
idDocTypeStringType of document that is specified in the level to be provided for verification. For example, PASSPORT, SELFIE, VIDEO_SELFIE, PAYMENT_METHOD and so on.

See the list of supported document types for details.
idDocSubTypeStringFRONT_SIDE, BACK_SIDE or null.

reviewResult attributes

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

FieldTypeDescription
reviewAnswerStringExplains the verification step review result.
  • GREEN — the action is approved.
  • RED — the action is rejected. See reviewRejectType for clarification.
moderationCommentStringA human-readable comment that explains the reasons for rejection, and that can be shown to the applicant.
clientCommentStringA human-readable comment that explains the reasons for rejection, and that must not be shown to the applicant.
reviewRejectTypeStringIndicates the type of rejection.
  • FINAL — final rejection in case of major violations. For example, the document data was modified, the document has been tampered with, and so on. If this is the case, you need to make a decision regarding the applicant on the basis of the rest data in the profile.
  • RETRY — temporary rejection in case of minor violations. For example, a screenshot was uploaded instead of a photo, part of the document is not visible, and so on. The applicant is sent a resubmission request to upload a new document or resubmit the correct data.
For more details, see Temporary rejection and Final rejection clarification.
rejectLabelsArray of stringsIncludes one or more reasons for rejection. The field is available if reviewAnswer returns RED.

For more details, see Temporary rejection and Final rejection clarification.

Response example

{
  "id": "668cc68dbd53cc0000000000",
  "createdAt": "2024-07-09 05:11:41",
  "clientId": "yourCoolId",
  "externalActionId": "123",
  "applicantId": "63e096c51b6b400000000000",
  "review": {
    "reviewId": "IUeLG",
    "attemptId": "wLjuf",
    "attemptCnt": 1,
    "elapsedSincePendingMs": 82,
    "levelName": "action-level-name",
    "createDate": "2024-07-09 10:24:26+0000",
    "reviewResult": {
      "reviewAnswer": "GREEN"
    },
    "reviewStatus": "completed"
  },
  "checks": [
    {
      "answer": "GREEN",
      "checkType": "PAYMENT_METHOD",
      "createdAt": "2024-07-09 10:24:26",
      "id": "b802aed3-0dd5-45b8-b9a2-7094cc7ede95",
      "attemptId": "RYyLx"
    }
  ],
  "requiredIdDocs": {
    "docSets": [
      {
        "idDocSetType": "PAYMENT_METHODS",
        "types": [ "PAYMENT_METHOD" ],
      }
    ]
  },
  "paymentMethod": {
    "type": "bankCard",
    "subType": "VISA",
    "data": {
      "requiredIdDoc": {
        "firstName": "John",
        "lastName": "Doe",
        "txnAmount": "100"
      }
    }
  },
  "reviewResult": {
    "reviewAnswer": "GREEN"
  }
}
Language
Authorization
Header
Click Try It! to start a request and see the response here!