Set up email provider

Many authentication use cases require sending emails to your users. Whether they are looking to verify their email address, reset their password, or be alerted of password changes, your users will need to receive these emails. This page shows the options for configuring email providers via the Purse Identity Console.

See the Email templates page if you are looking for templates.

Purse Identity integrates with the following email SaaS services:

We also provide:

  • generic integrations with SMTP servers.

  • an Email API to send the required information to a desired endpoint.

SMTP providers

You should use the SMTP provider to send emails if you have a reliable SMTP server available that will be able to handle all automated email distribution.

SMTP provider setup

  1. In the Purse Identity Console, go to Emails  Providers.

  2. Enter the SMTP configuration details.

    1. Specify the From email address. This is what the recipients see as who sent the email.

    2. Enter any Reply to email addresses that you wish to have. (Optional)

      When users reply, it will be sent to these emails.

    3. Enter the host for your SMTP server.

    4. Enter the port for that host SMTP server.

    5. Enter your username for the SMTP server.

    6. Enter the password associated with the above username for the SMTP server.

    7. Check SSL or TLS depending on your requirements.

      smtp provider config

  3. Select Send test email to validate the configuration.

    The email is sent to the address of the user currently logged in.

  4. Don’t forget to Save your input.

Custom providers

You should use the generic Email API to send emails when:

  • Purse Identity Console does not provide a native integration with your SaaS solution. You need to implement the generic email API, and then send your emails from your system as you would.

  • You use a custom or in-house piece of software to manage emails. You will need to implement our generic API and then map the data sent to your template and email service.

Custom message payload forward compatibility

We sometimes enhance our services by adding new variables and fields to custom Email and SMS payloads.

To ensure your integration remains stable:

  • Do not use strict schema validation on the JSON payloads received from Purse Identity.

  • Ignore unknown fields: Your integration must be designed to gracefully ignore any variables or keys it does not recognize.

Failure to follow this practice may cause your service to break when new features are released. This approach ensures that your integration continues to function correctly even as we introduce new features and enhancements.

Provider setup

  1. In the Purse Identity Console, go to Emails  Providers.

  2. Select Custom provider

  3. Specify the endpoint where you would like Purse Identity Console to send email requests.

    When sent, the REQUEST and payload are set and not customisable.

    We consider any response excluding 4xx and 5xx a success.

  4. If needed, enter the HTTP Authorization value. For example: Basic dm9yZGVsOnZvcmRlbA==. (Optional)

  5. If desired, add any custom fields to be sent.

  6. Select Send test email to validate the configuration.

    The email is sent to the address of the user currently logged in.

  7. Don’t forget to Save your input.

Select the endpoint where you would like Purse Identity to send requests

An example request and payload are as follows:

POST https://YOUR_DOMAIN

{
  "email": "clarence@example.com",
  "template_id": "verify_email", (1)
  "personalizations": {
     "id": "id",
     "client_id": "jQy...TGlj",
     "external_id": "externalId",
     "given_name": "Max",
     "last_name": "Robertson",
     "gender": "M",
     "has_password": true, (2)
     "lang": "fr",
     "locale": "fr-FR",
     "verification_code": "verificationCode",
     "redirect_url": "https://www.example.com/redirect",
     "lite_only": true, (3)
     "custom_fields": { (4)
        "loyalty_id": "123456"
      }
  }
}
1 The template_id is the email template. This is the ID for the template found at Settings  Emails  Templates or alternatively for MFA at Settings  MFA  email templates.
2 The has_password boolean is only included in the payload for the password_reset template.
3 The lite_only boolean is only included in the payload for the password_reset template to customize the email content for lite profiles.
4 The custom_fields object includes any custom fields you have defined for this custom email provider.

The has_password boolean gives custom providers the option to let users create a password.

  • true: The user already has a password; the user should be asked to reset the existing password.

  • false: The user does not have a password associated with their account; the user should be asked to create a password.

Custom personalization fields

The following are all of the possible personalizations you can use as part of the payload sent for custom providers.

Email

  • id

  • client_id

  • external_id

  • given_name

  • last_name

  • gender

  • has_password

  • lang

  • locale

  • verification_code

  • redirect_url

  • lite_only

  • custom_fields*

* custom_fields are defined by you and are represented as an object.

Adobe Campaign

You can integrate your Adobe Campaign Classic or Standard account with Purse Identity directly in the Purse Identity Console allowing you to leverage the digital marketing campaigns and personalized messages already established with Adobe Campaign.

This article only covers the steps in the Purse Identity Console. You’ll need the following information from your Adobe account in order to proceed:

OAuth Server-to-Server

Required from January 27, 2025.

JWT credentials

Deprecated from January 27, 2025.

  • Tenant ID for Adobe Campaign Classic or Standard

  • Your Adobe Campaign API Key

  • Your Adobe Campaign Client secret

  • The Organization ID you want to access.

  • The Technical Account ID you want to access.

  • The Private Key that corresponds to the public key provided with your Adobe Campaign settings.

For more information on how to find these items, see the Adobe Campaign Standard documentation.

Instructions

  1. In the Purse Identity Console, go to Emails  Providers.

  2. From the Client Type dropdown, choose Adobe Campaign Standard/Classic.

  3. Enter your Tenant ID.

  4. If desired, enable Use OAuth Credential. Doing so will grey out the standard JWT credential option.

    • OAuth Server-to-Server

    • JWT credentials

    1. Go to Settings  Emails  Providers on your Purse Identity Console.

    2. Select Adobe Campaign Standard from the list of options.

    3. Enable Use OAuth Credential.

    4. Enter your Client ID, Client secret, and desired Scope(s).

      Scopes

      Standard:

      • AdobeID

      • additional_info.projectedProductContext

      • campaign_config_server_general

      • campaign_sdk

      • deliverability_service_general

      • openid

      Classic:

      • adobeio_api

      • campaign_sdk

      • openid

      • deliverability_service_general

      • campaign_config_server_general

      • read_client_secret

      • AdobeID

      • additional_info.roles

      • manage_client_secrets

      • read_organizations

      • additional_info.projectedProductContext

    1. Enter your API Key.

    2. Enter your Adobe Campaign Standard Client Secret.

    3. Enter your Adobe Campaign Standard Organization ID.

    4. Enter the Technical Account ID of the account you want to access.

    5. Paste the Private Key that corresponds to the public key provided with your Adobe Campaign Standard settings.

  5. Don’t forget to Save your input.

Dialog Insight

You can integrate your Dialog Insight account with Purse Identity directly in the Purse Identity Console allowing you to leverage the digital marketing campaigns and personalized messages already established with Dialog Insight.

This article only covers the steps in the Purse Identity Console. You’ll need the following information from your Dialog Insight account in order to proceed:

  • Your Key ID.

  • Your Key.

  • Your Dialog Insight Project ID.

For more information on how to find these items, see Dialog Insight support.

Instructions

View from the console

dialog insight

  1. In the Purse Identity Console, go to Emails  Providers.

  2. From the Client Type dropdown, choose Dialog Insight.

  3. Enter your Key ID.

  4. Enter your Key information.

  5. Enter your Dialog Insight Project ID.

  6. If desired, choose the custom fields to send with each Dialog Insight message.

    Custom Fields lists the profile custom fields that Purse Identity may forward to Dialog Insight. Leave a field unselected if it should stay in Purse Identity only.

    Until you save this list, every custom field continues to be sent. After you save, only the selected fields are sent, and only when they are present on the profile. New custom fields you create later are not sent until you add them here. If you select none, no custom fields are sent.

    If you delete a custom field from the profile schema, it is also removed from this list.

  7. Don’t forget to Save your input.

Message parameters

Selected custom fields are sent as a customFields object on the Dialog Insight message.

Each send also includes clientId, the client ID used to perform the API call. This can be an Identity or Management client. Declare it on the Dialog Insight message if several Purse Identity clients share this project and the template should know which app triggered the email.

Parameters that are not defined on the Dialog Insight message are ignored, so the email is still sent.

Oracle Responsys

You can integrate your Oracle Responsys account with Purse Identity directly in the Purse Identity Console allowing you to leverage the digital marketing campaigns and personalized messages already established with Oracle Responsys Campaign Management.

This article only covers the steps in the Purse Identity Console. You’ll need the following information from your Oracle account in order to proceed:

  • Endpoint ID for Oracle Responsys

  • Your Oracle Responsys Username

  • Your Oracle Responsys Password

For more information on how to find these items, see the Oracle Responsys Help Center.

Instructions

  1. In the Purse Identity Console, go to Emails  Providers.

  2. From the Client Type dropdown, choose Oracle Responsys.

  3. Enter your Endpoint ID.

  4. Enter your Oracle Responsys Username.

  5. Enter your Oracle Responsys Password.

  6. Don’t forget to Save your input.

Splio

You can integrate your Splio account with Purse Identity directly in the Purse Identity Console allowing you to leverage the digital marketing campaigns and personalized messages already established with Splio.

This article only covers the steps in the Purse Identity Console. You’ll need the following information from your Splio account in order to proceed:

  • Your API Key.

  • Your Universe.

  • Your Splio Redirect URL Field ID.

For more information on how to find these items, see Splio resources.

Instructions

  1. In the Purse Identity Console, go to Emails  Providers.

  2. From the Client Type dropdown, choose Splio.

  3. Enter your API Key.

  4. Enter your Universe information.

  5. Enter your Splio Redirect URL Field ID.

  6. Don’t forget to Save your input.

Retry policy

When Purse Identity cannot deliver a message through your provider, it retries automatically before giving up.

This policy applies to the following templates:

Purse Identity makes up to 4 delivery attempts: one initial attempt, then 3 retries. After each failed attempt, Purse Identity waits 10 seconds before trying again. Each failed attempt creates an email_failure user event.

See User events for event fields and a sample payload.
Other transactional messages (such as signup verification or MFA codes) are sent once. If delivery fails, a single failure event is still emitted.
AI Assistant
The Purse Identity AI assistant can make mistakes, verify answers.

Confirm Deletion