Creates an applicant action.
Table of contents
Overview
Use this method to create an applicant action for a certain applicant with the required steps configured in the specified verification level.
You can create an applicant action to check:
Attention
If you specify a check in the request body parameters, make sure it is also set as a required step in the verification level.
For example, if you add the
paymentMethodobject to the request but do not include it as a required step in the specified level, the request will proceed without checking the payment method.
Tip
To check crypto transactions and/or e-wallets, we recommend to create specific applicant actions where no verification level configuration is required.
Specifics of questionnaire action
If you want to include the answers to your questionnaire into the action request, add the questionnaire properties to the body parameters. The questionnaire object should be added to the questionnaires array (see the example below).
Questionnaire object example:
{
"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
}
}
}
}
}
Request examples
curl -X POST \ 'https://api.sumsub.com/resources/applicantActions/-/forApplicant/63e096c51b6b4030f2e01154?levelName=some-level-name' \
-H 'Content-Type: application/json' \
-d '{
"externalActionId": "yourActionId",
"email": "[email protected]",
"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": "[email protected]",
"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": "[email protected]",
"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": "[email protected]",
"phone": "+49 123456789"
}'
Response explained
The response is a JSON file that represents the structured information of the created action. You can see the response structure and possible content with descriptions on the following page.
Response example
{
"id": "668cc68dbd53cc0000000000",
"createdAt": "2024-07-09 05:11:41",
"clientId": "yourClientId",
"externalActionId": "123-456-789",
"applicantId": "63e096c51b6b400000000000",
"review": {
"reviewId": "IUeLG",
"attemptId": "RYyLx",
"attemptCnt": 0,
"levelName": "actionLevelName",
"createDate": "2024-07-09 05:11:41+0000",
"reviewStatus": "init"
},
"requiredIdDocs": {
"docSets": [
{
"idDocSetType": "PAYMENT_METHODS",
"types": [
"PAYMENT_METHOD"
],
"paymentMethods": [
{
"type": "bankCard",
"requiredPhotosAmount": "some",
"subTypes": [
"VISA",
"MASTERCARD"
],
"fields": [
{
"name": "firstName",
"required": true
},
{
"name": "lastName",
"required": true
},
{
"name": "number",
"required": false
},
{
"name": "validUntil",
"required": false
}
]
}
]
}
]
},
"paymentMethod": {
"type": "bankCard",
"subType": "VISA",
"data": {
"requiredIdDoc": {
"firstName": "John",
"lastName": "Doe",
"txnAmount": "100"
}
}
}
}