We provide you with the following API methods to work with applicant actions.

Create applicant actions

You can create a new action using this API method.

curl -X POST \     
      'https://api.sumsub.com/resources/applicantActions/-/forApplicant/63e096c51b6b4030f2e01154?levelName=some-level-name' \
        -H 'Content-Type: application/json' \
        -d '{
              "externalActionId": "yourActionId",
              "email": "example@email.com",
              "phone": "+49 123456789"
            }'

curl -X POST \     
      'https://api.sumsub.com/resources/applicantActions/-/forApplicant/63e096c51b6b4030f2e01154?levelName=payment-level' \
        -H 'Content-Type: application/json' \
        -d '{
              "paymentMethod": {
                "data": {
                  "requiredIdDoc": {
                    "firstName": "John",
                    "lastName": "Doe",
                    "number": "0000111122223333",
                    "issuedDate": "2023-02-25",
                    "txnAmount": "500"
                  }
                },
                "type": "bankCard",
                "subType": "VISA"
              },
              "externalActionId": "yourActionId",
              "email": "example@email.com",
              "phone": "+49 123456789"
            }'

curl -X POST \    
      'https://api.sumsub.com/resources/applicantActions/-/forApplicant/63e096c51b6b4030f2e01154/?levelName=action%20paymentSource%20level-name' \
        -H 'Content-Type: application/json' \
        -d '{
              "paymentSource": {
                "fixedInfo": {
                  "accountIdentifier": "XXX000333",
                  "email": "example@email.com",
                  "fullName": "John Doe",
                  "type": "bankCard",
                  "institutionName": "someBank"
                }
              },
              "externalActionId": "yourActionId"
            }'

curl -X POST \     
      'https://api.sumsub.com/resources/applicantActions/-/forApplicant/63e096c51b6b4030f2e01154?levelName=questionnaire-level' \
        -H 'Content-Type: application/json' \
        -d '{
              "questionnaires": [
                {
                  "id": "Example_Questionnaire",
                  "sections": {
                    "section_id_1": { // Section ID
                      "items": {
                        "item_id_0": { // Item ID
                          "values": [ // Item values
                            "EUR",
                            "USD"
                          ]
                        },
                        "item_id_1": { // Item ID
                          "value": "String Value", // Item values, string
                        }
                      }
                    },
                    "section_id_2": { // Section ID
                      "items": {
                        "item_id_3": { // Item ID
                          "value": null // Item values, null
                        }
                      }
                    }
                  }
                }
              ],
              "externalActionId": "yourActionId",
              "email": "example@email.com",
              "phone": "+49 123456789"
            }'

Get applicant actions

You can get the list of all actions that belong to particular applicants using the applicant ID with the help of this API method.

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

Also, you can get the applicant actions linked to a particular transaction by including a unique transaction identifier kytTxnReference.txnId={txnId}.

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

Add images to applicant actions

You can add an image file to an applicant action. For example, a bank card image to the payment method using this API method.

curl -X POST \
      'https://api.sumsub.com/resources/applicantActions/5e022e0f0a975a45325c7ff5/images' \
        -H 'Content-Type: multipart/form-data' \
        -F 'metadata={"idDocType":"PAYMENT_METHOD","country":"GBR"}' \
        -F 'content=@/Sumsub/Example/name.jpg'

Request action check

You can initiate the action check with the help of this API method.

curl -X POST \
      'https://api.sumsub.com/resources/applicantActions/5e022e0f0a975a45325c7ff5/review/status/pending'

Get action check results

You can get the check results using this API method.

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

Get images from applicant actions

You can retrieve an image from an action using this API method.

curl -X GET \
      'https://api.sumsub.com/resources/applicantActions/639999ef054d540000000000/images/853651000?preview=true' \

Add payment method information

You can add information to the payment method using this API method.

curl -X POST \
      'https://api.sumsub.com/resources/applicantActions/5e022e0f0a975a45325c7ff5/paymentMethod' \
      -H 'Content-Type: application/json' \
      -d '{
            "type": "bankCard",
            "subType": "VISA",
            "data": {
              "requiredIdDoc": {
                "firstName": "John",
                "lastName": "Doe",
                "number": "4321434321"
              }
            }
          }'

Create actions with crypto transaction data

You can create an action to check crypto transactions and e-wallets using this API method.

The following are examples of the request payload to check a deposit transaction where no tokenId is required.

curl -X POST \
      'https://api.sumsub.com/resources/applicantActions/-/forApplicant/5f905c29e971ff53e5ec79e5/cryptoSourceOfFunds' \
      -H 'Content-Type: application/json' \
      -d '{
              "direction": "deposit",
              "txn": "cb68af8c91b6e8ac284f7370effd176f13c62f79c8e8fb6b2f890e802f5dd191",
              "address": "1JWF1vJyyxxWJ27T9G3kStyFUGp47hvKiP",
              "currency": "BTC"
          }’

curl -X POST \
      'https://api.sumsub.com/resources/applicantActions/-/forApplicant/5f905c29e971ff53e5ec79e5/cryptoSourceOfFunds' \
      -H 'Content-Type: application/json' \
      -d '{
              "direction": "deposit",
              "txn": "29a3efd3ef04f9153d47a990bd7b048a4b2d213daaa5fb8ed670fb85f13bdbcf",
              "address": "1P3S1grZYmcqYDuaEDVDYobJ5Fx85E9fE9",
              "currency": "BSV"
          }'

The following are examples of the request payload to check a deposit transaction where you need to specify the tokenId.

curl -X POST \
      'https://api.sumsub.com/resources/applicantActions/-/forApplicant/5f905c29e971ff53e5ec79e5/cryptoSourceOfFunds' \
      -H 'Content-Type: application/json' \
      -d '{
              "direction": "deposit",
              "txn": "0x1087be99d867e5e68120a3ce464661596680ded3158c7257773c03fc1bc6e351",
              "address": "0x9f8622b11984afc8f0a42a394928702017c5968d",
              "currency": "ETH",
              "tokenId": "172805"
          }'

curl -X POST \
      'https://api.sumsub.com/resources/applicantActions/-/forApplicant/5f905c29e971ff53e5ec79e5/cryptoSourceOfFunds' \
      -H 'Content-Type: application/json' \
      -d '{
              "direction": "deposit",
              "txn": "0x977dc0c94334340a86ed7591defbfce7bbca30a0290ebf60b96388c4e56c5741",
              "address": "0xe81c65a55d60021c8bd0dc269ed2732780b5d238",
              "currency": "ERC-20",
              "tokenId": "OMGToken"
          }’

The following are example of the request payload in case you need to check a crypto wallet (for withdrawals).

curl -X POST \
      'https://api.sumsub.com/resources/applicantActions/-/forApplicant/5f905c29e971ff53e5ec79e5/cryptoSourceOfFunds' \
      -H 'Content-Type: application/json' \
      -d '{
              "direction": "withdrawal",
              "address": "1JWF1vJyyxxWJ27T9G3kStyFUGp47hvKiP",
              "currency": "BTC"
          }’