Create verification group

Create a new verification group to enable ordering local phone numbers for a specific region.

Endpoint

POST /v1/verification-groups

Request Body

Field	Type	Required	Description
`phone_number_type`	string	Yes	Type: `local`, `mobile`, or `national`
`name`	string	Yes	Internal name for this group
`business_name`	string	Yes	Official business name
`contact_person_first_name`	string	Yes	Contact person's first name
`contact_person_last_name`	string	Yes	Contact person's last name
`contact_person_phone`	string	Yes	Contact person's phone number
`street_name`	string	Yes	Street name
`house_number`	string	Yes	House number
`postal_code`	string	Yes	Postal code
`city`	string	Yes	City
`province`	string	Yes	Province
`description`	string	No	Optional description

Example Request

Example Response

{
  "message": "Verification group created",
  "data": {
    "requirement_group_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Request JSON Schema

{
  "type": "object",
  "properties": {
    "phone_number_type": {
      "type": "string",
      "enum": ["local", "mobile", "national"],
      "description": "Type of phone numbers this group will be used for"
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "description": "Internal name for the verification group"
    },
    "business_name": {
      "type": "string",
      "minLength": 1,
      "description": "Official business name"
    },
    "contact_person_first_name": {
      "type": "string",
      "minLength": 1,
      "description": "Contact person's first name"
    },
    "contact_person_last_name": {
      "type": "string",
      "minLength": 1,
      "description": "Contact person's last name"
    },
    "contact_person_phone": {
      "type": "string",
      "minLength": 1,
      "description": "Contact person's phone number"
    },
    "street_name": {
      "type": "string",
      "minLength": 1,
      "description": "Street name"
    },
    "house_number": {
      "type": "string",
      "minLength": 1,
      "description": "House number"
    },
    "postal_code": {
      "type": "string",
      "minLength": 1,
      "description": "Postal code"
    },
    "city": {
      "type": "string",
      "minLength": 1,
      "description": "City"
    },
    "province": {
      "type": "string",
      "minLength": 1,
      "description": "Province"
    },
    "description": {
      "type": "string",
      "description": "Optional description"
    }
  },
  "required": [
    "phone_number_type",
    "name",
    "business_name",
    "contact_person_first_name",
    "contact_person_last_name",
    "contact_person_phone",
    "street_name",
    "house_number",
    "postal_code",
    "city",
    "province"
  ]
}

Response JSON Schema

{
  "type": "object",
  "properties": {
    "message": { "type": "string" },
    "data": {
      "type": "object",
      "properties": {
        "requirement_group_id": { 
          "type": "string", 
          "format": "uuid",
          "description": "Unique ID of the created verification group"
        }
      }
    }
  }
}

Error Codes

Code	HTTP Status	Description
`invalid_parameters`	400	Missing or invalid fields

Next:
After creating a group, check its status or wait for approval to search available numbers.

Create verification group

Endpoint#

Request Body#

Example Request#

Example Response#

Request JSON Schema#

Response JSON Schema#

Error Codes#

Endpoint

Request Body

Example Request

Example Response

Request JSON Schema

Response JSON Schema

Error Codes