Management APIReferenceRegulation Address

GetAvailableRegulations

View as Markdown

Searches for the available regulation for a link.

Allowed roles: Owner, Accountant.

Example request: Search available regulation address.

Authentication

AuthorizationBearer
Voximplant Management API uses signed JWT tokens generated from your service-account private key. Pass the token in the `Authorization` header as a Bearer value: ``` Authorization: Bearer $VOXIMPLANT_TOKEN ``` See [Authorization](/api-reference/management-api/authorization) for ready-to-copy snippets in bash, Python, Node.js and Go that turn your `credentials.json` into a token.

Query parameters

country_codestringRequired

The country code according to the ISO 3166-1 alpha-2

phone_category_namestringRequired

The phone category name. See the [GetPhoneNumberCategories] method

phone_region_codestringOptional

The phone region code. See the [GetRegions] method

Response

Successful response
resultboolean or integer
Whether the user has at least one regulation address which is appropriate for verification or the verification is not required. If result is false, the regulations address needs to be created
available_addresslist of objects
The available RegulationAddress records
count_in_progressinteger
The count of RegulationAddress in progress status