1. References
  2. Management API
  3. RegulationAddress
Rate this page:

RegulationAddress

Methods

GetAvailableRegulations

Copy URL

Searches for the available regulation for a link.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Accountant
GetAvailableRegulations example
Copy

GetAvailableRegulations example

Search available regulation address.

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

    Optional

    The phone region code. See the GetRegions method

Returns

  • available_address:

    [RegulationAddress]

    The available RegulationAddress records

  • count_in_progress:

    number

    The count of RegulationAddress in progress status

  • result:

    boolean

    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

GetCountries

Copy URL

Gets all countries.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
Accountant
Payer
GetCountries example
Copy

GetCountries example

Get Germany.

Parameters

  • country_code:

    string

    Optional

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

Returns

GetRegions

Copy URL

Gets available regions in a country.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
Accountant
GetRegions example
Copy

GetRegions example

Get regions with city AACHEN.

Parameters

  • city_name:

    string

    Optional

    The pattern of city's name

  • count:

    number

    Optional

    The returned regions count

  • country_code:

    string

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

  • offset:

    number

    Optional

    The first N records are skipped in the output

  • phone_category_name:

    string

    The phone category name. See the GetPhoneNumberCategories method

Returns

GetRegulationsAddress

Copy URL

Searches for the user's regulation address.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
Accountant
Payer
PayerNoVerify
GetRegulationsAddress example
Copy

GetRegulationsAddress example

Search regulation address with ID = 1.

Parameters

  • country_code:

    string

    Optional

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

  • in_progress:

    boolean

    Optional

    Whether to show only in progress regulation address

  • phone_category_name:

    string

    Optional

    The phone category name. See the GetPhoneNumberCategories method

  • phone_region_code:

    string

    Optional

    The phone region code. See the GetRegions method

  • regulation_address_id:

    number

    Optional

    The regulation address ID

  • verified:

    boolean

    Optional

    Whether to show only verified regulation address

Returns

  • count:

    number

    The returned regulation address count

  • result:

    [RegulationAddress]

    The RegulationAddress records

GetZIPCodes

Copy URL

Searches for available zip codes.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
Accountant
GetZIPCodes example
Copy

GetZIPCodes example

Search for zip codes in Germany.

Parameters

  • count:

    number

    Optional
    Defaults on:  20

    The max returning record count

  • country_code:

    string

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

  • offset:

    number

    Optional
    Defaults on:  0

    The first N records are skipped in the output

  • phone_region_code:

    string

    Optional

    The phone region code

Returns

  • count:

    number

    The returned zip codes count

  • result:

    [ZipCode]

    The ZipCode records

LinkRegulationAddress

Copy URL

Links the regulation address to a phone.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
Accountant
Payer
LinkRegulationAddress example
Copy

LinkRegulationAddress example

Link the regulation address to a phone number.

Parameters

  • phone_id:

    number

    The phone ID for link

  • phone_number:

    string

    The phone number for link

  • regulation_address_id:

    number

    The regulation address ID

Returns

  • result:

    boolean