---
title: "Create applicant action"
method: POST
path: "/resources/applicantActions/-/forApplicant/{applicantId}"
---

# Create applicant action

`POST /resources/applicantActions/-/forApplicant/{applicantId}`

## Request

- Base URL: `https://api.sumsub.com`
- URL: `https://api.sumsub.com/resources/applicantActions/-/forApplicant/{applicantId}`
- Auth: API key in header `X-App-Token`
- TypeScript: <https://skmtc.dev/sumsub/apis/sumsub-api/docs/resources/applicantActions/-/forApplicant/:applicantId/post~2.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `applicantId` string, required

## Query parameters

- `levelName` string, required

## Request body

- object
  - `externalActionId` string, required: Unique identifier of the applicant action on your side.<br><br>⚠️ This value must be unique across your entire account — reusing an `externalActionId` for a different applicant action (whether for the same applicant or a different one) causes the request to be rejected.
  - `paymentSource` object: Represents the payment source data and includes specific information about the payment method required from the applicant.
    - `fixedInfo` object: Additional fixed information related to a payment source.
      - `type` 'bankCard' | 'bankAccount' | 'bankStatement' | 'eWallet' | 'cryptoWallet': Payment source type that can be `bankCard`, `bankAccount`, `bankStatement`, `eWallet`, or `cryptoWallet`. <br><br>⚠️ This field is rather important as it determines what the applicant will see within the WebSDK flow.
      - `fullName` string: Full name of the payment source account holder (for example, John Doe).
      - `accountIdentifier` string: Unique payment source account identifier.
      - `institutionName` string: Name of the financial institution where the payment source account is held (for example, Revolut).
      - `country` string: Alpha-3 code of the country where the financial institution is registered (for example, `DEU`, `GBR`, `ARG`).
      - `email` string: Email address associated with the payment source account.
      - `phone` string: Phone number associated with the payment source account.
      - `validUntil` string, date: Date when the payment source account validity expires. Format: `YYYY-MM-DD`.
      - `cryptoChain` string: Crypto chain name. Mandatory for crypto tokens only. Specifies the network name to which the token at currencyCode belongs. Empty for native tokens (for example, for `BTC`, `ETH`). For more information, see [Working with Crypto Assets](ref:working-with-crypto-assets). ⚠️ Applicable to the `cryptoWallet` type only.
      - `currencyCode` string: Code of the currency the wallet holds (for example, `USD`, `GBP`, `BTC`). ⚠️ Applicable to the `cryptoWallet` type only.
      - `memo` string: Optional field to attach metadata or messages for identification, routing, or compliance purposes. ⚠️ Applicable to the `cryptoWallet` type only.
    - `checksum` object: Required only if you want to enable [auto-parsing for bank statement transactions](#auto-parser-for-bank-statement-transactions).
      - `txns` object[]: Transaction details.
        - `date` string, date-time: Date and time (UTC) of the transaction, in the format `YYYY-MM-DD hh:mm:ss` (for example, `2024-01-23 23:00:00`).
        - `amount` number, double: Transaction amount. Must be a positive floating point value (> 0).
        - `currencyCode` string: Code of the currency used in the transaction (for example, `USD`, `GBP`, `BTC`).
  - `questionnaires` unknown[]: Add the `questionnaire` object within. See [Specifics of questionnaire action](#specifics-of-questionnaire-action) for more details.
    - unknown
  - `email` string: Applicant email address.<br><br>It is mandatory if the [email verification](doc:email-and-phone-verification) is required. If not provided, the applicant cannot receive [verification status emails](doc:review-results-in-applicant-profile#send-verification-status-email).
  - `phone` string: Applicant phone number.<br><br>It is mandatory if the [phone verification](doc:email-and-phone-verification) is required.

---

[API](https://skmtc.dev/sumsub/apis/sumsub-api.md) - [All operations](https://skmtc.dev/sumsub/apis/sumsub-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sumsub/apis/sumsub-api/revisions/fcc702e558a2?raw)