Clerk · JSON Structure

Clerk Phonenumber Structure

JSON Structure overview of Clerk PhoneNumber entity.

Type: Properties: 0 Required: 7
AuthenticationAuthorizationB2B SaaSCIAMIdentity ManagementMFAOAuthOpenID ConnectOrganizationsPasskeysSAMLSecuritySessionsSSOUser Management

Clerk Phonenumber Structure is a JSON Structure definition published by Clerk. It conforms to the https://json-structure.org/schema/v0 meta-schema.

Meta-schema: https://json-structure.org/schema/v0

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/schema/v0",
  "title": "Clerk PhoneNumber Structure",
  "description": "JSON Structure overview of Clerk PhoneNumber entity.",
  "entity": "PhoneNumber",
  "fields": [
    {
      "name": "id",
      "type": "string",
      "description": "",
      "format": null,
      "nullable": false
    },
    {
      "name": "object",
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value.\n",
      "format": null,
      "nullable": false
    },
    {
      "name": "phone_number",
      "type": "string",
      "description": "",
      "format": null,
      "nullable": false
    },
    {
      "name": "reserved_for_second_factor",
      "type": "boolean",
      "description": "",
      "format": null,
      "nullable": false
    },
    {
      "name": "default_second_factor",
      "type": "boolean",
      "description": "",
      "format": null,
      "nullable": false
    },
    {
      "name": "reserved",
      "type": "boolean",
      "description": "",
      "format": null,
      "nullable": false
    },
    {
      "name": "verification",
      "type": "object",
      "description": "",
      "format": null,
      "nullable": true
    },
    {
      "name": "linked_to",
      "type": "array",
      "description": "",
      "format": null,
      "nullable": false
    },
    {
      "name": "backup_codes",
      "type": "array",
      "description": "",
      "format": null,
      "nullable": true
    },
    {
      "name": "created_at",
      "type": "integer",
      "description": "Unix timestamp of creation\n",
      "format": "int64",
      "nullable": false
    },
    {
      "name": "updated_at",
      "type": "integer",
      "description": "Unix timestamp of creation\n",
      "format": "int64",
      "nullable": false
    }
  ],
  "required": [
    "object",
    "phone_number",
    "verification",
    "linked_to",
    "reserved",
    "created_at",
    "updated_at"
  ]
}