Overview

Use this method to send mass email notifications recursively to all associated parties within a company structure.

A common use case for this endpoint is to remind applicants whose progress has stalled and who are delaying overall company verification.

Notifications can only be sent to applicants who have an email address provided and saved in their profiles. Eligible beneficiaries must be in one of the following applicant statuses: Documents requested, Resubmission requested, or Awaiting user.

📘

Note

The following limits apply to this method:

• Maximum number of beneficiaries per company that can receive notifications is 100.
• Maximum number of email addresses that can receive notifications is 100.

👍

Did you know?

You can update the email address in the applicant profile with the following method.

Request example

curl -X POST \
     'https://api.sumsub.com/resources/applicants/673f390478c5cc60a492aa39/verificationStatusEmailToBeneficiaries' \
     -H 'X-App-Token: <your-app-token>' \
     -H 'X-App-Access-Sig: <your-signature>' \
     -H 'X-App-Access-Ts: <unix-timestamp>'

Response explained

If the request is successfully processed, the following response is returned, indicating that the notifications have been sent.

{
  "ok": 1
}

If the request fails, you will receive an HTTP response containing an error code along with a message explaining the error. For example:

{
  "code": 400,
  "correlationId": "54eb6d6ae8a929e208a919638204dc79",
  "description": "Invalid id '123456'"
}