REST Resource: projects.regulatoryListings

Resource: RegulatoryListing

The regulatory listing resource.

JSON representation

{
  "name": string,
  "displayName": string,
  "address": {
    object (GenericAddress)
  },
  "person": {
    object (PersonDetails)
  },
  "business": {
    object (BusinessDetails)
  },
  "createTime": string (Timestamp),
  "valid": boolean,
  "verified": boolean
}

Fields
name	string Resource name of the regulatory listing. It must match the pattern projects/*/regulatoryListings/*
displayName	string The display name of the regulatory listing. Max length 100 characters.
address	object (GenericAddress) Immutable. The address of this regulatory listing.
person	object (PersonDetails) Immutable. The person associated with the listing.
business	object (BusinessDetails) Immutable. The business or corporation associated with the listing.
createTime	string (Timestamp format) Output only. The creation time of the regulatory listing.
valid	boolean Output only. Whether this regulatory listing is considered valid. This state may change after manual review.
verified	boolean Output only. Whether this regulatory listing has been verified. Verification is only required for some types of phone numbers, and is performed at request by Enfonica.

GenericAddress

An address in a generic format.

The validation of some fields varies based on region_code. For example: - AU/NZ: locality (city) required, adminsitrative_area (city) required, postal_code required with 4 digits. - US: locality (city) required, adminsitrative_area (city) required, postal_code required with 5 digits.

JSON representation

{
  "addressLines": [
    string
  ],
  "locality": string,
  "administrativeArea": string,
  "postalCode": string,
  "regionCode": string
}

Fields
addressLines[]	string Required. The address lines. Maximum length of each line is 200 characters. Must specify 1 or 2 lines.
locality	string Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
administrativeArea	string Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
postalCode	string The postal code. Maximum 16 characters.
regionCode	string Required. The alpha-2 country code (capitalized).

PersonDetails

The details of a person.

JSON representation

{
  "givenName": string,
  "familyName": string
}

Fields
givenName	string Required. The given name of the person. Maximum length 100 characters.
familyName	string Required. The family name of the person. Maximum length 100 characters.

BusinessDetails

The details of a business or corporation.

JSON representation

{
  "business": string
}

Fields
business	string Required. The full legal name of the business. Maximum length 200 characters.

Methods

Methods
create	POST /v1beta1/{parent}/regulatoryListings Creates a regulatory listing. By creating a regulatory listing, you acknowledge that the person or entity located at the specified address is the only party that will be utilizing phone numbers associated with this regulatory listing. You acknowledge that Enfonica may process the information provided for the purpose of identity verification, and will share this information with local telecommunications providers or authorities where required by local law. You understand that Enfonica phone numbers may be taken out of service if inaccurate or false information has been provided. The caller must have numbering.regulatoryListings.create permission on the project.
get	GET /v1beta1/{name} Retrieves a regulatory listing. The caller must have numbering.regulatoryListings.get permission on the project.
list	GET /v1beta1/{parent}/regulatoryListings Lists all regulatory listings. List returns regulatory listings sorted by create_time descending. The caller must have numbering.regulatoryListings.list permission on the project.
update	PATCH /v1beta1/{regulatory_listing.name} Updates a regulatory listing. The caller must have numbering.regulatoryListings.update permission on the project.
delete	DELETE /v1beta1/{name} Deletes a regulatory listing. Regulatory listings that are associated with an active phone number instance cannot be deleted. The caller must have numbering.regulatoryListings.delete permission on the project.
search	GET /v1beta1/{parent}/regulatoryListings:search Searches all usable regulatory listings with the specified number type. List returns regulatory listings sorted by create_time descending. The caller must have numbering.regulatoryListings.list permission on the project.