LOloket
Email Identities

Verify an EmailIdentity for an employer

Activity name: <a href="https://developer.loket.nl/Activities/PostVerifyEmailIdentityByEmployerId" target="_blank">PostVerifyEmailIdentityByEmployerId</a><br> <br><br>Verify an EmailIdentity for an employer. The verficationstatus will we saved and used by Loket when sending email. <br>

post/v2/providers/employers/{employerId}/emailidentities/verify

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/{employerId}/emailidentities/verify
  • Auth
    none required

Path parameters

employerIdstring uuid required

The unique identifier of the employer

Headers

Authorizationstring required
Example:Bearer <TOKEN>

A valid Bearer token for authorizing the request.

Acceptstring required
Example:application/json;version=2018-01-01

The accept header is used to influence what type of output is returned and in most cases the version of the output

Request body

idstring uuid

The unique identifier of an object (GUID/UUID)

emailIdentitystring

The emailIdentity that can be used when sending email.

emailIdentityType'DOMAIN'

The type of the set emailIdentity

isSpfVerifiedboolean

Indicates whether the EmailIdentity has passed Spf verfication.

isDkimVerifiedboolean

Indicates whether the EmailIdentity has passed Spf verfication.

lastDkimVerifiedOnstring date

The date the Dkim settings were last verified.

lastSpfVerifiedOnstring date

The date the Spf settings were last verified.

dkimTokensstring[] nullable

Example request

{
  "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
  "emailIdentity": "provider.com",
  "isSpfVerified": true,
  "isDkimVerified": true,
  "lastDkimVerifiedOn": "2022-01-31",
  "lastSpfVerifiedOn": "2022-01-31",
  "dkimTokens": [
    "u6deqmqhlgn3wxslcp4cugcz7ognh4gt"
  ]
}

Response

Verified

Example response

{
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "content": {
    "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "emailIdentity": "provider.com",
    "isSpfVerified": true,
    "isDkimVerified": true,
    "lastDkimVerifiedOn": "2022-01-31",
    "lastSpfVerifiedOn": "2022-01-31",
    "dkimTokens": [
      "u6deqmqhlgn3wxslcp4cugcz7ognh4gt"
    ]
  }
}

Changes

No recorded changes to this operation across all 6 revisions of this API.