StartVerificationRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/sinch/main/json-schema/sinch-start-verification-request-schema.json",
  "title": "StartVerificationRequest",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/sinch-verifications-api-openapi.yml#/components/schemas/StartVerificationRequest",
  "type": "object",
  "required": [
    "identity",
    "method"
  ],
  "properties": {
    "identity": {
      "type": "object",
      "required": [
        "type",
        "endpoint"
      ],
      "description": "The identity to verify",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "number"
          ],
          "description": "The identity type"
        },
        "endpoint": {
          "type": "string",
          "description": "The phone number in E.164 format"
        }
      }
    },
    "method": {
      "type": "string",
      "enum": [
        "sms",
        "flashcall",
        "callout",
        "seamless"
      ],
      "description": "The verification method to use"
    },
    "reference": {
      "type": "string",
      "description": "A custom reference string for tracking the verification"
    },
    "custom": {
      "type": "string",
      "description": "Custom data to pass to callbacks"
    },
    "metadata": {
      "type": "object",
      "description": "Additional metadata for the verification request"
    }
  }
}