RegulationAddress
Methods
LinkRegulationAddress
Links the regulation address to a phone
Parameters
regulation_address_id:
number
The regulation address ID
phone_id:
number
The phone ID for link
phone_number:
string
The phone number for link
Returns
result:
boolean
GetZIPCodes
Searches for available zip codes
Parameters
country_code:
string
The country code according to the ISO 3166-1 alpha-2.
phone_region_code:
string
OptionalThe phone region code
count:
number
OptionalDefaults on: 20The max returning record count.
offset:
number
OptionalDefaults on: 0The first N records will be skipped in the output.
Returns
result:
The ZipCode records.
count:
number
The returned zip codes count.
GetRegulationsAddress
Searches for the user's regulation address
Parameters
country_code:
string
OptionalThe country code according to the ISO 3166-1 alpha-2.
phone_category_name:
string
OptionalThe phone category name. See the GetPhoneNumberCategories method.
phone_region_code:
string
OptionalThe phone region code. See the GetRegions method.
regulation_address_id:
number
OptionalThe regulation address ID.
verified:
boolean
OptionalShow only verified regulation address.
in_progress:
boolean
OptionalShow only in progress regulation address.
Returns
result:
The RegulationAddress records.
count:
number
The returned regulation address count.
GetAvailableRegulations
Searches for the available regulation for a link
Parameters
country_code:
string
The country code according to the ISO 3166-1 alpha-2.
phone_category_name:
string
The phone category name. See the GetPhoneNumberCategories method.
phone_region_code:
string
OptionalThe phone region code. See the GetRegions method.
Returns
result:
boolean
If result equals 1: 1) the user has at least one regulation address which is appropriate for verification or 2) the verification is not required. If result equals 0, the regulations address needs to be created.
available_address:
The available RegulationAddress records.
count_in_progress:
number
The count of RegulationAddress in progress status.
GetCountries
Gets all countries
Parameters
country_code:
string
OptionalThe country code according to the ISO 3166-1 alpha-2.
Returns
result:
count:
number
GetRegions
Gets available regions in a country
Parameters
country_code:
string
The country code according to the ISO 3166-1 alpha-2.
phone_category_name:
string
The phone category name. See the GetPhoneNumberCategories method.
city_name:
string
OptionalThe pattern of city's name
count:
number
OptionalThe returned regions count.
offset:
number
OptionalThe first N records will be skipped in the output.
Returns
result:
count:
number