Get a Contact-Verification

GET/v2/contact-verifications/{contactVerificationId}/

API version

v2

Request method

GET

Operation ID

domain-get-contact-verification

---

Request

• contactVerificationIdstring (uuid)

  required

Responses

Format

application/json

Description

OK

Schema documentation

• idstring (uuid)

  required
• statusstring (one of: created, pending, completed, failed)

  required
• typeDataone of 3 alternatives

  required
  • Alternativeobject
    • type"address"

      required
    • valuestring

      required
  • Alternativeobject
    • emailVerificationDeadlinestring (date-time)
    • lastEmailSentDatestring (date-time)
    • type"email"

      required
    • valuestring

      required
  • Alternativeobject
    • type"name"

      required
    • valuestring

      required

Example

Content-Type: application/json

{
  "id": "f0f86186-0a5a-45b2-aa33-502777496347",
  "status": "created",
  "typeData": {
    "type": "address",
    "value": "string"
  }
}

JSON Schema

{
  "properties": {
    "id": {
      "format": "uuid",
      "type": "string"
    },
    "status": {
      "enum": [
        "created",
        "pending",
        "completed",
        "failed"
      ],
      "type": "string"
    },
    "typeData": {
      "oneOf": [
        {
          "properties": {
            "type": {
              "enum": [
                "address"
              ],
              "type": "string"
            },
            "value": {
              "type": "string"
            }
          },
          "required": [
            "type",
            "value"
          ],
          "type": "object"
        },
        {
          "properties": {
            "emailVerificationDeadline": {
              "format": "date-time",
              "type": "string"
            },
            "lastEmailSentDate": {
              "format": "date-time",
              "type": "string"
            },
            "type": {
              "enum": [
                "email"
              ],
              "type": "string"
            },
            "value": {
              "type": "string"
            }
          },
          "required": [
            "type",
            "value"
          ],
          "type": "object"
        },
        {
          "properties": {
            "type": {
              "enum": [
                "name"
              ],
              "type": "string"
            },
            "value": {
              "type": "string"
            }
          },
          "required": [
            "type",
            "value"
          ],
          "type": "object"
        }
      ]
    }
  },
  "required": [
    "id",
    "status",
    "typeData"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/contact-verifications/f0f86186-0a5a-45b2-aa33-502777496347

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.domain.getContactVerification({
  "contactVerificationId": "f0f86186-0a5a-45b2-aa33-502777496347"
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Domain\GetContactVerification\GetContactVerificationRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new GetContactVerificationRequest(
  contactVerificationId: "f0f86186-0a5a-45b2-aa33-502777496347"
));
$response = $client->domain()->getContactVerification($request);

var_dump($response->getBody();