Update an Address

    Updates the address object by setting the values of the parameters passed. Parameters which are not provided will remain unchanged.

    API Endpoint

    POST https://api.plivo.com/v1/Account/{auth_id}/Verification/Address/{id}/

    Arguments

    country_iso

    Country ISO 2 code

    alias

    Alias name of the address

    salutation

    This can have the following values:

    • “Mr”

    • “Ms”

    first_name

    First name of the user for whom the identity is created

    last_name

    Second name of the user for whom the identity is created

    address_line1

    Building name/number

    address_line2

    The street name/number of the address

    city

    The city of the address for which the address proof is created

    region

    The region of the address for which the address proof is created

    postal_code

    The postal code of the address that is being created

    file

    A file to upload, which needs to be considered the proof of ID. Max. file Size = 5MB* File should be in jpg, pdf, or png format.

    auto_correct_address

    If set to true, the address will be auto-corrected by the system if necessary. The param needs to be set to false explicitly so that it is not auto-corrected.

    Returns

    Returns a confirmation that the object is updated.

    Response

    {
      "message": "Your request has been accepted.",
      "api_id": "5a9fcb68-523d-11e1-86da-6ff39efcb949"
    }
    

    Example Request

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    
    import plivo
    
    client = plivo.RestClient()
    response = client.addresses.update(
        address_id='32208455725227',
        salutation='Mr',
        first_name='Bruce',
        last_name='Wayne', )
    print(response)
    
    # Or, you can use the address object directly
    address = client.addresses.get(
        address_id='32208455725227', )
    response = address.update(
        salutation='Mr',
        first_name='Bruce',
        last_name='Wayne', )
    print(response)
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    
    /**
     * Example for Account Get
     */
    using System;
    using System.Collections.Generic;
    using Plivo;
    using Plivo.Exception;
    
    namespace PlivoExamples
    {
        internal class Program
        {
            public static void Main(string[] args)
            {
                var api = new PlivoApi("YOUR_AUTH_ID", "YOUR_AUTH_TOKEN");
                string fileName = "path/to/file.jpg";
                try
                {
                    var response = api.Address.Update(
                        "addressId",
                        salutation:"Mr",
                        fileToUpload:fileName
                    );
                    Console.WriteLine(response);
                }
                catch (PlivoRestException e)
                {
                    Console.WriteLine("Exception: " + e.Message);
                }
            }
        }
    }