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

RegulationAddress

Methods

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

  • 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

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

  • country_code:

    string

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

  • phone_region_code:

    string

    Optional

    The phone region code

  • count:

    number

    Optional
    Defaults on:  20

    The max returning record count

  • offset:

    number

    Optional
    Defaults on:  0

    The first N records will be skipped in the output

Returns

  • result:

    [ZipCode]

    The ZipCode records

  • count:

    number

    The returned zip codes count

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

  • 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

    Show only verified regulation address

  • in_progress:

    boolean

    Optional

    Show only in progress regulation address

Returns

  • result:

    [RegulationAddress]

    The RegulationAddress records

  • count:

    number

    The returned regulation address count

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

  • 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:

    [RegulationAddress]

    The available RegulationAddress records

  • count_in_progress:

    number

    The count of RegulationAddress in progress status

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

  • 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

    Optional

    The pattern of city's name

  • count:

    number

    Optional

    The returned regions count

  • offset:

    number

    Optional

    The first N records will be skipped in the output

Returns