Latest Legacy

List all Addresses

Returns a list of addresses.

API Endpoint

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

Arguments

country_iso

Country ISO 2 code

customer_name

Name of the customer or business that is mentioned in the address

alias

Friendly name of the id proof

verification_status

The status of the address: pending. accepted, rejected, null

validation_status

The status of the address: pending. accepted, rejected, null

limit

A limit on the number of addresses to be returned. limit can range between 1 and 20.

offset

A pagination cursor to denote the number of objects by which the results should be offset. For instance, if your search request has a result of 100 objects with limit= 10 and offset = 5, then objects with indices 51 through 60 are returned.

Returns

An array of Address objects.

Response

HTTP Status Code: 200

{
  "api_id": "af8b199a-0b58-11e8-b939-06755d68f0ca",
  "meta": {
    "limit": 1,
    "next": "https://api.plivo.com/v1/Account/MAXXXXXXXXXXXXXXXXXX/Verification/Address/?limit=1&offset=1",
    "offset": 0,
    "previous": null,
    "total_count": 22
  },
  "objects": [
    {
      "account": "MAXXXXXXXXXXXXXXXXXX",
      "address_line1": "128",
      "address_line2": "RUE DU COMMANDANT GUILBAUD",
      "alias": "test_address",
      "city": "PARIS",
      "country_iso": "FR",
      "document_details": {
        "address_line1": "128",
        "address_line2": "RUE DU COMMANDANT GUILBAUD",
        "city": "PARIS",
        "first_name": "Bruce",
        "last_name": "Wayne",
        "postal_code": "75016",
        "region": "PARIS",
        "salutation": "Mr"
      },
      "first_name": "Bruce",
      "id": "20220771838737",
      "last_name": "Wayne",
      "postal_code": "75016",
      "region": "PARIS",
      "salutation": "Mr",
      "subaccount": null,
      "url": "https://api.plivo.com/v1/Account/MAXXXXXXXXXXXXXXXXXX/Verification/Address/20220771838737/",
      "validation_status": "accepted",
      "verification_status": "pending"
    }
  ]
}

Example Request

1
2
3
4
5
6
7
import plivo

client = plivo.RestClient()
response = client.addresses.list(
    offset=0,
    limit=5, )
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
/**
 * 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");
            try
            {
                var response = api.Address.List();
                Console.WriteLine(response);
            }
            catch (PlivoRestException e)
            {
                Console.WriteLine("Exception: " + e.Message);
            }
        }
    }
}