SIGN UP

Managing regulation address

Methods

Add regulation address for any country except the Russian Federation.

Parameters

  • Follow link for authentication parameter names and details.

  • phone_category_name:

    string

    The phone category name. See the GetPhoneNumberCategories method.

  • destination_country_code:

    string

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

  • phone_owner_country_code:

    string

    The owner's country code. Default uses destination_country_code

  • proof:

    string

    Send as Body Request or multiform. Supported formats: JPG, JPEG, PNG, TIFF, PDF. Maximum size is 5 Mb.

  • phone_region_code:

    string

    The phone region code. See the GetRegions method.

  • phone_owner_salutation:

    string

    This is the salutation of the end user for the created address: MR or MS if phone_owner_first_name and phone_owner_last_name are used or COMPANY if phone_owner_company is used

  • phone_owner_first_name:

    string

    This is the first name for the end user of the created address. It is a required field if the phone_owner_salutation is MR or MS.

  • phone_owner_last_name:

    string

    This is the last name for the end user of the created address. It is a required field if the phone_owner_salutation is MR or MS.

  • phone_owner_company:

    string

    This is the company name for the end user of the created address. It is a required field if the phone_owner_salutation is COMPANY.

  • phone_owner_zip_code:

    string

    This is the zip code of the end user’s address.

  • phone_owner_city:

    string

    This is the city of the end user’s address.

  • phone_owner_street:

    string

    This is the name of the end user’s street.

  • phone_owner_building_number:

    string

    This is the number of the building or the street number of the address.

  • phone_owner_building_letter:

    string

    This is the building letter which can also be used for additional information on the street number.

Returns

  • result:

    boolean
  • regulation_address_id:

    number

    ID of regulation address

Examples

request:

Add new regulation address

https://api.voximplant.com/platform_api/CreateRegulationAddress/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&phone_category_name=GEOGRAPHIC&destination_country_code=DE&phone_owner_country_code=DE&phone_region_code=243&phone_owner_salutation=COMPANY&phone_owner_company=ABC&phone_owner_zip_code=5000012&phone_owner_city=AAHEN&phone_owner_street=street&phone_owner_building_number=1

response:

{
    "result": true,
    "regulation_address_id": 2
}

Search available regulation for link

Parameters

  • Follow link for authentication parameter names and details.

  • 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

    The phone region code. See the GetRegions method.

Returns

  • result:

    boolean

    If result equal 1 then user has more regulation address or they did not wanted. Otherwise, you need to create regulations address.

  • available_address:

    [ RegulationAddress ]

    The available RegulationAddress records.

  • count_in_progress:

    number

    The count of RegulationAddress in progress status.

Examples

request:

Search available regulation address

https://api.voximplant.com/platform_api/GetAvailableRegulations/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&country_code=DE&phone_category_name=GEOGRAPHIC&phone_region_code=643

response:

{
    "result": 1,
    "available_address": [
        {
            "id": 1,
            "city": "City",
            "status": "VERIFIED",
            "street": "street",
            "zip_code": "140000",
            "last_name": "last",
            "first_name": "First",
            "salutation": "MR",
            "external_id": "12345",
            "country_code": "DE",
            "builder_number": "10",
            "phone_category_name": "GEOGRAPHIC"
        }
    ],
    "count_in_progress": 0
}

Get all countries

Parameters

  • Follow link for authentication parameter names and details.

  • country_code:

    string

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

Returns

Examples

request:

Get Germany

https://api.voximplant.com/platform_api/GetCountries/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&country_code=DE

response:

{
    "count": 1,
    "result": [
        {
            "country_code": "DE",
            "country_name": "Germany"
        }
    ]
}

Get available regions in country

Parameters

  • Follow link for authentication parameter names and details.

  • 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

    The pattern of city's name

  • count:

    number

    The returned regions count.

  • offset:

    number

    The first N records will be skipped in the output.

Returns

Examples

request:

Get regions with city AACHEN.

https://api.voximplant.com/platform_api/GetRegions/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&country_code=DE&phone_category_name=GEOGRAPHIC&city_name=AACHEN

response:

{
    "count": 1,
    "result": [
        {
            "phone_region_id": 1,
            "phone_region_code": "241",
            "phone_region_name": "AACHEN",
            "regulation_address_type": "LOCAL",
            "is_need_regulation_address": true
        }
    ]
}

Search user's regulation address

Parameters

  • Follow link for authentication parameter names and details.

  • 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

    The phone region code. See the GetRegions method.

  • regulation_address_id:

    number

    The regulation address ID.

  • verified:

    boolean

    Show only verified regulation address.

  • in_progress:

    boolean

    Show only in progress regulation address.

Returns

  • The RegulationAddress records.

  • count:

    number

    The returned regulation address count.

Examples

request:

Search regulation address with ID = 1

https://api.voximplant.com/platform_api/GetRegulationsAddress/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac®ulation_address_id=1

response:

{
    "count": 1,
    "result": [
        {
            "id": 1,
            "city": "City",
            "status": "IN_PROGRESS",
            "street": "street",
            "zip_code": "140000",
            "last_name": "last",
            "first_name": "First",
            "salutation": "MR",
            "external_id": "12345",
            "country_code": "DE",
            "builder_number": "10",
            "phone_category_name": "GEOGRAPHIC"
        }
    ]
}

Search available zip codes

Parameters

  • Follow link for authentication parameter names and details.

  • country_code:

    string

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

  • phone_region_code:

    string

    The phone region code

  • count:

    number
    Defaults to 20

    The max returning record count.

  • offset:

    number
    Defaults to 0

    The first N records will be skipped in the output.

Returns

  • result:

    [ ZipCode ]

    The ZipCode records.

  • count:

    number

    The returned zip codes count.

Examples

request:

Search zip codes in Germany

https://api.voximplant.com/platform_api/GetZIPCodes/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&country_code=DE&count=1

response:

{
    "count": 1,
    "result": [
        {
            "city": "AACHEN",
            "zip_code": "52062"
        }
    ]
}

Link regulation address to phone

Parameters

  • Follow link for authentication parameter names and details.

  • 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

Examples

request:

Link regulation address to phone number

https://api.voximplant.com/platform_api/LinkregulationAddress/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac®ulation_address_id=1&phone_id=1

response:

{
    "result": 1
}

Upload proof of address for any country except the Russian Federation.

Parameters

  • Follow link for authentication parameter names and details.

  • regulation_address_id:

    number

    The regulation address id

  • proof:

    string

    Send as Body Request or multiform. Supported formats: JPG, JPEG, PNG, TIFF, PDF. Maximum size is 5 Mb.

Returns

  • result:

    boolean

Examples

request:

Upload proof of address.

https://api.voximplant.com/platform_api/UploadProofOfAddress/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac®ulation_address_id=1

response:

{
    "result": 1
}