messagebird · Schema

Verify

Properties

Name	Type	Description
id	string	The unique identifier of the verification.
href	string	The URL of the verification resource.
recipient	string	The phone number being verified.
reference	string	The client reference.
status	string	The status of the verification.
messages	object	Links to the associated message objects.
createdDatetime	string	The date and time when the verification was created.
validUntilDatetime	string	The date and time when the verification token expires.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Verify",
  "title": "Verify",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier of the verification."
    },
    "href": {
      "type": "string",
      "format": "uri",
      "description": "The URL of the verification resource."
    },
    "recipient": {
      "type": "string",
      "description": "The phone number being verified."
    },
    "reference": {
      "type": "string",
      "description": "The client reference."
    },
    "status": {
      "type": "string",
      "description": "The status of the verification.",
      "enum": [
        "sent",
        "expired",
        "failed",
        "verified",
        "deleted"
      ]
    },
    "messages": {
      "type": "object",
      "description": "Links to the associated message objects.",
      "properties": {
        "href": {
          "type": "string",
          "format": "uri",
          "description": "The URL of the associated messages."
        }
      }
    },
    "createdDatetime": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time when the verification was created."
    },
    "validUntilDatetime": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time when the verification token expires."
    }
  }
}