Sign in
OpenAPI 3.1.0raw.githubusercontent.com2026-08-191,3412,1385.0 MB

ec31f78cf002

Requirement Groups

Create a new requirement group

Creates a regulatory requirement group for a country, number type, and ordering or porting action. Optional customer-reference and requirement values are retained on the created group.

post/requirement_groups

Request body

action'ordering' | 'porting' required
country_codestring required

ISO alpha 2 country code

customer_referencestring
phone_number_type'local' | 'toll_free' | 'mobile' | 'national' | 'shared_cost' required

Example request

{
  "action": "ordering",
  "country_code": "US",
  "customer_reference": "My Requirement Group",
  "phone_number_type": "local"
}

Response

Requirement group created

actionstring
country_codestring
created_atstring date-time
customer_referencestring
idstring
phone_number_typestring
record_typestring
status'approved' | 'unapproved' | 'pending-approval' | 'declined' | 'expired'
updated_atstring date-time

Example response

{
  "record_type": "requirement_group"
}