Trusted email addresses

PingID SDK supports the ability to configure up to 10 trusted email address for an existing trusted email domain. See Trusted email domains.

Trusted email address representation

Property	Description
`id`	A string that specifies the auto-generated ID of the trusted email address.
`emailAddress`	A string that specifies the trusted email address, for example `john.smith@shopco.com`.
`status`	A string that specifies the status of the trusted email address. Possible values: ACTIVE VERIFICATION_REQUIRED

Trusted email address activation request representation

Property	Description
`verificationCode`	A string that specifies a one-time passcode sent to the trusted email address.

Create trusted email address (POST)

The POST operation adds a new trusted email address resource entity to a trusted email domain resource in the specified account.

A verification code is sent to provided email address, and the response code will be 201 Successfully created.

Relative Path

/accounts/{accountId}/emaildomains/{emailDomainId}/trustedemails

Request body structure

{
  "emailAddress": "<email address>"
}

Create trusted email address request example

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ \ 
   "emailAddress": " john.smith%40auth.shopco.com" \ 
 }' 'https://sdk.pingid.com/pingid/v1/accounts/f851a4da-1239-4008-9456-8b93279558f2/emaildomains/40ea89b1-65aa-4ee9-8316-ef0e405567a2/trustedemails'

Create trusted email address response example

{
  "emailDomain": {
    "href": "https://sdk.pingid.com/pingid/v1/accounts/f851a4da-1239-4008-9456-8b93279558f2/emaildomains/40ea89b1-65aa-4ee9-8316-ef0e405567a2"
  },
  "self": {
    "href": "https://sdk.pingid.com/pingid/v1/accounts/f851a4da-1239-4008-9456-8b93279558f2/emaildomains/40ea89b1-65aa-4ee9-8316-ef0e405567a2/trustedemails/59f1384b-9640-4556-9c1e-9f0d5fb7efa6"
  },
  "account": {
    "href": "https://sdk.pingid.com/pingid/v1/accounts/f851a4da-1239-4008-9456-8b93279558f2"
  },
  "id": "59f1384b-9640-4556-9c1e-9f0d5fb7efa6",
  "emailAddress": "john.smith@auth.shopco.com",
  "status": "VERIFICATION_REQUIRED"
}

Activate trusted email address (POST)

The POST operation is used to activate a new trusted email address resource of a trusted email domain in the specified account.

Note: The email address can be activated in the 24-hour period after the verification code has been sent.

Relative Path

/accounts/{accountId}/emaildomains/{emailDomainId}/trustedemails/{trustedEmailId}/activate

Request body structure

{
  "verificationCode": "<verification code>"
}

Activate trusted email address request example

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ \ 
   "verificationCode": "ck3wxi6z" \ 
 }' 'https://sdk.pingid.com/pingid/v1/accounts/f851a4da-1239-4008-9456-8b93279558f2/emaildomains/40ea89b1-65aa-4ee9-8316-ef0e405567a2/trustedemails/59f1384b-9640-4556-9c1e-9f0d5fb7efa6/activate'

Activate trusted email address response example

{
  "emailDomain": {
    "href": "https://sdk.pingid.com/pingid/v1/accounts/f851a4da-1239-4008-9456-8b93279558f2/emaildomains/40ea89b1-65aa-4ee9-8316-ef0e405567a2"
  },
  "trustedEmail": {
    "href": "https://sdk.pingid.com/pingid/v1/accounts/f851a4da-1239-4008-9456-8b93279558f2/emaildomains/40ea89b1-65aa-4ee9-8316-ef0e405567a2/trustedemails/59f1384b-9640-4556-9c1e-9f0d5fb7efa6"
  },
  "self": {
    "href": "https://sdk.pingid.com/pingid/v1/accounts/f851a4da-1239-4008-9456-8b93279558f2/emaildomains/40ea89b1-65aa-4ee9-8316-ef0e405567a2/trustedemails/59f1384b-9640-4556-9c1e-9f0d5fb7efa6/activate"
  },
  "account": {
    "href": "https://sdk.pingid.com/pingid/v1/accounts/f851a4da-1239-4008-9456-8b93279558f2"
  },
  "id": "59f1384b-9640-4556-9c1e-9f0d5fb7efa6",
  "emailAddress": "john.smith@auth.shopco.com",
  "status": "ACTIVE"
}

Resend verification code to email (POST)

The POST operation is used to resend a verification code to a new trusted email address resource of a trusted email domain in the specified account.

Relative Path

/accounts/{accountId}/emaildomains/{emailDomainId}/trustedemails/{trustedEmailId}/resend

Resend verification code to email request example

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' 'https://sdk.pingid.com/pingid/v1/accounts/f851a4da-1239-4008-9456-8b93279558f2/emaildomains/40ea89b1-65aa-4ee9-8316-ef0e405567a2/trustedemails/59f1384b-9640-4556-9c1e-9f0d5fb7efa6/resend'

Resend verification code to email response example

{
  "emailDomain": {
    "href": "https://sdk.pingid.com/pingid/v1/accounts/f851a4da-1239-4008-9456-8b93279558f2/emaildomains/40ea89b1-65aa-4ee9-8316-ef0e405567a2"
  },
  "trustedEmail": {
    "href": "https://sdk.pingid.com/pingid/v1/accounts/f851a4da-1239-4008-9456-8b93279558f2/emaildomains/40ea89b1-65aa-4ee9-8316-ef0e405567a2/trustedemails/59f1384b-9640-4556-9c1e-9f0d5fb7efa6"
  },
  "self": {
    "href": "https://sdk.pingid.com/pingid/v1/accounts/f851a4da-1239-4008-9456-8b93279558f2/emaildomains/40ea89b1-65aa-4ee9-8316-ef0e405567a2/trustedemails/59f1384b-9640-4556-9c1e-9f0d5fb7efa6/resend"
  },
  "account": {
    "href": "https://sdk.pingid.com/pingid/v1/accounts/f851a4da-1239-4008-9456-8b93279558f2"
  },
  "id": "59f1384b-9640-4556-9c1e-9f0d5fb7efa6",
  "emailAddress": "john.smith@auth.shopco.com",
  "status": "VERIFICATION_REQUIRED"
}

Get trusted email address (POST)

To GET operation returns data for the trusted email address resource with the specified ID.

Relative Path

/accounts/{accountId}/emaildomains/{emailDomainId}/trustedemails/{trustedEmailId}

Get trusted email address request example

curl -X GET --header 'Accept: application/json' 'https://sdk.pingid.com/pingid/v1/accounts/f851a4da-1239-4008-9456-8b93279558f2/emaildomains/40ea89b1-65aa-4ee9-8316-ef0e405567a2/trustedemails/59f1384b-9640-4556-9c1e-9f0d5fb7efa6'

Get trusted email address response example

{
  "emailDomain": {
    "href": "https://sdk.pingid.com/pingid/v1/accounts/f851a4da-1239-4008-9456-8b93279558f2/emaildomains/40ea89b1-65aa-4ee9-8316-ef0e405567a2"
  },
  "self": {
    "href": "https://sdk.pingid.com/pingid/v1/accounts/f851a4da-1239-4008-9456-8b93279558f2/emaildomains/40ea89b1-65aa-4ee9-8316-ef0e405567a2/trustedemails/59f1384b-9640-4556-9c1e-9f0d5fb7efa6"
  },
  "account": {
    "href": "https://sdk.pingid.com/pingid/v1/accounts/f851a4da-1239-4008-9456-8b93279558f2"
  },
  "id": "59f1384b-9640-4556-9c1e-9f0d5fb7efa6",
  "emailAddress": "john.smith@auth.shopco.com",
  "status": "VERIFICATION_REQUIRED"
}

Note: Use the expand query parameter to get details on the email domain of the trusted email address.

Get trusted email address request example (with expand on email domain)

curl -X GET --header 'Accept: application/json' 'https://sdk.pingid.com/pingid/v1/accounts/f851a4da-1239-4008-9456-8b93279558f2/emaildomains/40ea89b1-65aa-4ee9-8316-ef0e405567a2/trustedemails/59f1384b-9640-4556-9c1e-9f0d5fb7efa6?expand=emailDomain'

Get trusted email address response example (with expand on email domain)

{
  "self": {
    "href": "https://sdk.pingid.com/pingid/v1/accounts/f851a4da-1239-4008-9456-8b93279558f2/emaildomains/40ea89b1-65aa-4ee9-8316-ef0e405567a2/trustedemails/59f1384b-9640-4556-9c1e-9f0d5fb7efa6"
  },
  "account": {
    "href": "https://sdk.pingid.com/pingid/v1/accounts/f851a4da-1239-4008-9456-8b93279558f2"
  },
  "emailDomain": {
    "id": "40ea89b1-65aa-4ee9-8316-ef0e405567a2",
    "domainName": "auth.shopco.com"
  },
  "id": "59f1384b-9640-4556-9c1e-9f0d5fb7efa6",
  "emailAddress": "john.smith@auth.shopco.com",
  "status": "VERIFICATION_REQUIRED"
}

Get bulk trusted email addresses (GET)

Get all the trusted email addresses of a trusted email domain.

Relative Path

/accounts/{accountId}/emaildomains/{emailDomainId}/trustedemails

Get bulk trusted email addresses request example

curl -X GET --header 'Accept: application/json' 'https://sdk.pingid.com/pingid/v1/accounts/f851a4da-1239-4008-9456-8b93279558f2/emaildomains/40ea89b1-65aa-4ee9-8316-ef0e405567a2/trustedemails'

Get bulk trusted email addresses response example

{
  "self": {
    "href": "https://sdk.pingid.com/pingid/v1/accounts/f851a4da-1239-4008-9456-8b93279558f2/emaildomains/40ea89b1-65aa-4ee9-8316-ef0e405567a2/trustedemails"
  },
  "trustedemails": [
    {
      "id": "59f1384b-9640-4556-9c1e-9f0d5fb7efa6",
      "emailAddress": "john.smith@auth.shopco.com",
      "status": "VERIFICATION_REQUIRED"
    }
  ]
}

Delete trusted email address (DELETE)

Use the DELETE operation to delete a trusted email address resource of a trusted email domain resource entity, specified by its ID in the request URL.

Note: You cannot delete a trusted email address that is used in an email template.

Relative Path

/accounts/{accountId}/emaildomains/{emailDomainId}/trustedemails/{trustedEmailId}

Delete trusted email address request example

curl -X DELETE --header 'Accept: application/json' 'https://sdk.pingid.com/pingid/v1/accounts/f851a4da-1239-4008-9456-8b93279558f2/emaildomains/40ea89b1-65aa-4ee9-8316-ef0e405567a2/trustedemails/59f1384b-9640-4556-9c1e-9f0d5fb7efa6'

Delete trusted email address response example

HTTP 204 status