List Contact-Verifications belonging to the executing user

GET/v2/contact-verifications/

API version

v2

Request method

GET

Operation ID

domain-list-contact-verifications

---

Request

Responses

Format

application/json

Beschreibung

OK

Schema-Dokumentation

• Array[
  • *object
    • 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
  ]

Beispiel

Content-Type: application/json

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

JSON Schema

{
  "items": {
    "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"
  },
  "type": "array"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/contact-verifications?value=string&type=name

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.listContactVerifications({
  "queryParameters": {
    "value": "string",
    "type": "name"
  }
});

assertStatus(response, 200);
  

PHP SDK

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

$request = (new ListContactVerificationsRequest())
  ->withValue("string")
  ->withType("name");
$response = $client->domain()->listContactVerifications($request);

var_dump($response->getBody();